From 5a4e88f8556a38fa4a2dd82dc00a30925873f3fd Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 9 Oct 2026 00:18:49 +0000 Subject: [PATCH 1/3] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.787.0 --- .speakeasy/gen.lock | 68 ++-- .speakeasy/gen.yaml | 2 +- .speakeasy/out.openapi.yaml | 44 +-- .speakeasy/workflow.lock | 10 +- RELEASES.md | 12 +- docs/models/components/aabenchmarkentry.mdx | 6 +- docs/models/components/activityitem.mdx | 26 +- docs/models/components/activityresponse.mdx | 2 +- .../models/components/additionaltoolsitem.mdx | 8 +- .../components/additionaltoolsitemtool.mdx | 4 +- .../additionaltoolsitemtoolfunction.mdx | 14 +- docs/models/components/advisorreasoning.mdx | 4 +- .../components/advisorservertoolconfig.mdx | 16 +- .../advisorservertoolopenrouter.mdx | 4 +- docs/models/components/agent.mdx | 4 +- docs/models/components/agentmessageitem.mdx | 14 +- .../agentmessageitemcontentinputimage.mdx | 8 +- docs/models/components/alignment.mdx | 2 +- .../components/alignmentallowedcallrecord.mdx | 6 +- .../components/alignmentblockedcallrecord.mdx | 6 +- docs/models/components/alignmentchataudio.mdx | 4 +- docs/models/components/alignmentchatimage.mdx | 4 +- .../components/alignmentchatimageimageurl.mdx | 2 +- .../components/alignmentchatrejected.mdx | 12 +- .../components/alignmentchattoolcall.mdx | 6 +- .../alignmentchattoolcallfunction.mdx | 4 +- docs/models/components/alignmentplugin.mdx | 12 +- .../models/components/alignmentrulerecord.mdx | 4 +- .../alignmentunavailablecallrecord.mdx | 6 +- docs/models/components/allowedtools.mdx | 4 +- docs/models/components/always.mdx | 2 +- .../components/annotationaddedevent.mdx | 14 +- docs/models/components/annotationfile.mdx | 4 +- .../components/annotationurlcitation.mdx | 4 +- .../annotationwebsearchcitation.mdx | 4 +- .../anthropicadvisormessageusageiteration.mdx | 14 +- .../components/anthropicadvisortoolresult.mdx | 6 +- .../components/anthropicbase64imagesource.mdx | 6 +- .../components/anthropicbase64pdfsource.mdx | 6 +- .../anthropicbashcodeexecutionoutput.mdx | 4 +- .../anthropicbashcodeexecutionresult.mdx | 10 +- .../anthropicbashcodeexecutiontoolresult.mdx | 6 +- ...hropicbashcodeexecutiontoolresulterror.mdx | 4 +- .../anthropiccachecontroldirective.mdx | 4 +- .../components/anthropiccachecreation.mdx | 4 +- .../anthropiccitationcharlocation.mdx | 14 +- .../anthropiccitationcharlocationparam.mdx | 12 +- .../anthropiccitationcontentblocklocation.mdx | 14 +- ...ropiccitationcontentblocklocationparam.mdx | 12 +- .../anthropiccitationpagelocation.mdx | 14 +- .../anthropiccitationpagelocationparam.mdx | 12 +- .../components/anthropiccitationsconfig.mdx | 2 +- .../anthropiccitationsearchresultlocation.mdx | 14 +- ...ropiccitationsearchresultlocationparam.mdx | 14 +- ...thropiccitationwebsearchresultlocation.mdx | 10 +- ...iccitationwebsearchresultlocationparam.mdx | 10 +- .../anthropiccodeexecution20250825caller.mdx | 4 +- .../anthropiccodeexecution20260120caller.mdx | 4 +- .../anthropiccodeexecutionoutput.mdx | 4 +- .../anthropiccodeexecutionresult.mdx | 10 +- .../anthropiccodeexecutiontoolresult.mdx | 6 +- .../anthropiccodeexecutiontoolresulterror.mdx | 4 +- .../components/anthropiccompactionblock.mdx | 6 +- .../anthropiccompactionusageiteration.mdx | 12 +- docs/models/components/anthropiccontainer.mdx | 6 +- .../components/anthropiccontainerskill.mdx | 6 +- .../components/anthropiccontainerupload.mdx | 4 +- .../components/anthropicdirectcaller.mdx | 2 +- .../components/anthropicdocumentblock.mdx | 8 +- .../anthropicdocumentblockparam.mdx | 12 +- .../anthropicdocumentblockparamcitations.mdx | 2 +- .../anthropicencryptedcodeexecutionresult.mdx | 10 +- docs/models/components/anthropicfile.mdx | 16 +- .../components/anthropicfiledeleted.mdx | 6 +- .../anthropicfiledocumentsource.mdx | 4 +- docs/models/components/anthropicfilelist.mdx | 10 +- .../components/anthropicimageblockparam.mdx | 6 +- .../anthropicinputtokensclearatleast.mdx | 4 +- .../anthropicinputtokenstrigger.mdx | 4 +- .../anthropicinputtransformation.mdx | 8 +- .../anthropiciterationcachecreation.mdx | 4 +- .../anthropicmessageoutputconfig.mdx | 2 +- .../anthropicmessageusageiteration.mdx | 14 +- .../anthropicoutputtokensdetails.mdx | 2 +- .../components/anthropicplaintextsource.mdx | 6 +- .../anthropicredactedthinkingblock.mdx | 4 +- .../anthropicrefusalstopdetails.mdx | 6 +- docs/models/components/anthropicsafeguard.mdx | 6 +- .../anthropicsearchresultblockparam.mdx | 12 +- ...thropicsearchresultblockparamcitations.mdx | 2 +- .../components/anthropicservertoolusage.mdx | 4 +- docs/models/components/anthropictextblock.mdx | 6 +- .../components/anthropictextblockparam.mdx | 8 +- ...pictexteditorcodeexecutioncreateresult.mdx | 4 +- ...exteditorcodeexecutionstrreplaceresult.mdx | 12 +- ...ropictexteditorcodeexecutiontoolresult.mdx | 6 +- ...texteditorcodeexecutiontoolresulterror.mdx | 6 +- ...ropictexteditorcodeexecutionviewresult.mdx | 12 +- .../components/anthropicthinkingblock.mdx | 6 +- .../anthropicthinkingblockbinding.mdx | 4 +- .../components/anthropicthinkingturns.mdx | 4 +- .../components/anthropictoolreference.mdx | 4 +- .../components/anthropictoolsearchresult.mdx | 4 +- .../anthropictoolsearchresulterror.mdx | 6 +- .../anthropictoolsearchtoolbm25.mdx | 12 +- .../anthropictoolsearchtoolregex.mdx | 12 +- .../anthropictoolsearchtoolresult.mdx | 6 +- .../components/anthropictooluseblock.mdx | 10 +- .../components/anthropictooluseskeep.mdx | 4 +- .../components/anthropictoolusestrigger.mdx | 4 +- .../anthropicunknownusageiteration.mdx | 12 +- .../components/anthropicurlimagesource.mdx | 4 +- .../components/anthropicurlpdfsource.mdx | 4 +- .../components/anthropicwebfetchblock.mdx | 8 +- .../anthropicwebfetchtoolresult.mdx | 8 +- .../anthropicwebfetchtoolresulterror.mdx | 4 +- .../components/anthropicwebsearchresult.mdx | 10 +- .../anthropicwebsearchresultblockparam.mdx | 10 +- .../anthropicwebsearchtoolresult.mdx | 8 +- .../anthropicwebsearchtoolresulterror.mdx | 4 +- .../anthropicwebsearchtooluserlocation.mdx | 10 +- docs/models/components/applypatchcallitem.mdx | 10 +- .../applypatchcalloperationdiffdeltaevent.mdx | 10 +- .../applypatchcalloperationdiffdoneevent.mdx | 10 +- .../components/applypatchcalloutputitem.mdx | 10 +- .../applypatchcreatefileoperation.mdx | 6 +- .../applypatchdeletefileoperation.mdx | 4 +- .../components/applypatchservertool.mdx | 2 +- .../components/applypatchservertoolconfig.mdx | 2 +- .../applypatchservertoolopenrouter.mdx | 4 +- .../applypatchupdatefileoperation.mdx | 6 +- docs/models/components/apprankingsitem.mdx | 10 +- .../models/components/apprankingsresponse.mdx | 4 +- docs/models/components/architecture.mdx | 10 +- docs/models/components/audiourl.mdx | 2 +- .../components/autobetarouterplugin.mdx | 12 +- docs/models/components/autorouterplugin.mdx | 14 +- .../badgatewayresponseerrordata.mdx | 6 +- .../badrequestresponseerrordata.mdx | 6 +- docs/models/components/baseinputsmessage.mdx | 8 +- .../models/components/basereasoningconfig.mdx | 8 +- docs/models/components/bashservertool.mdx | 4 +- .../components/bashservertoolconfig.mdx | 4 +- docs/models/components/batchdeletedobject.mdx | 6 +- .../components/batchdeletiontargets.mdx | 4 +- .../components/batcherrorresponseerror.mdx | 4 +- docs/models/components/batchlistitem.mdx | 24 +- .../batchlistitemcompletiontokensdetails.mdx | 6 +- docs/models/components/batchlistitemerror.mdx | 2 +- .../batchlistitemprompttokensdetails.mdx | 10 +- .../components/batchlistitemrequestcounts.mdx | 6 +- .../components/batchlistitemservertooluse.mdx | 6 +- docs/models/components/batchlistitemusage.mdx | 26 +- docs/models/components/batchlistresponse.mdx | 10 +- docs/models/components/batchobject.mdx | 24 +- .../batchobjectcompletiontokensdetails.mdx | 6 +- docs/models/components/batchobjectdata.mdx | 6 +- docs/models/components/batchobjectdebug.mdx | 6 +- docs/models/components/batchobjecterror.mdx | 2 +- docs/models/components/batchobjectfile.mdx | 6 +- .../models/components/batchobjectfunction.mdx | 4 +- .../models/components/batchobjectimageurl.mdx | 2 +- .../batchobjectprompttokensdetails.mdx | 10 +- .../components/batchobjectrequestcounts.mdx | 6 +- .../models/components/batchobjectresponse.mdx | 6 +- .../components/batchobjectservertooluse.mdx | 6 +- .../batchobjectservertoolusedetails.mdx | 6 +- docs/models/components/batchobjecttimings.mdx | 6 +- .../components/batchobjecturlcitation.mdx | 10 +- docs/models/components/batchobjectusage.mdx | 26 +- ...equiredresponsecompletiontokensdetails.mdx | 6 +- .../batchpaymentrequiredresponseerror.mdx | 4 +- ...entrequiredresponseprompttokensdetails.mdx | 10 +- ...chpaymentrequiredresponserequestcounts.mdx | 6 +- ...chpaymentrequiredresponseservertooluse.mdx | 6 +- .../batchpaymentrequiredresponseusage.mdx | 26 +- .../components/batchproviderpreferences.mdx | 4 +- docs/models/components/batchsubmitbody.mdx | 10 +- docs/models/components/bodychatcompletion.mdx | 24 +- .../bodycompletiontokensdetails.mdx | 6 +- docs/models/components/bodylist.mdx | 10 +- docs/models/components/bodymessage.mdx | 22 +- .../components/bodyprompttokensdetails1.mdx | 10 +- .../components/bodyprompttokensdetails2.mdx | 10 +- docs/models/components/bodyservertooluse.mdx | 6 +- docs/models/components/bodyusage1.mdx | 14 +- docs/models/components/bodyusage2.mdx | 22 +- docs/models/components/bodyusage3.mdx | 12 +- docs/models/components/booleancapability.mdx | 2 +- .../bulkaddworkspacemembersrequest.mdx | 2 +- .../bulkaddworkspacemembersresponse.mdx | 4 +- .../components/bulkassignkeysrequest.mdx | 2 +- .../components/bulkassignkeysresponse.mdx | 2 +- .../components/bulkassignmembersrequest.mdx | 2 +- .../components/bulkassignmembersresponse.mdx | 2 +- .../bulkremoveworkspacemembersrequest.mdx | 2 +- .../bulkremoveworkspacemembersresponse.mdx | 2 +- .../components/bulkunassignkeysrequest.mdx | 2 +- .../components/bulkunassignkeysresponse.mdx | 2 +- .../components/bulkunassignmembersrequest.mdx | 2 +- .../bulkunassignmembersresponse.mdx | 2 +- docs/models/components/byokkey.mdx | 32 +- .../models/components/chatassistantimages.mdx | 2 +- .../chatassistantimagesimageurl.mdx | 2 +- .../components/chatassistantmessage.mdx | 20 +- docs/models/components/chataudiooutput.mdx | 8 +- docs/models/components/chatchoice.mdx | 8 +- docs/models/components/chatcontentaudio.mdx | 4 +- .../components/chatcontentaudioinputaudio.mdx | 4 +- .../components/chatcontentcachecontrol.mdx | 4 +- docs/models/components/chatcontentfile.mdx | 4 +- .../models/components/chatcontentfilefile.mdx | 6 +- docs/models/components/chatcontentimage.mdx | 4 +- .../components/chatcontentimageimageurl.mdx | 4 +- docs/models/components/chatcontenttext.mdx | 8 +- docs/models/components/chatcontentvideo.mdx | 4 +- .../components/chatcontentvideoinput.mdx | 4 +- docs/models/components/chatdebugoptions.mdx | 2 +- .../components/chatdevelopermessage.mdx | 8 +- ...hatdevelopermessageconfigurationupdate.mdx | 2 +- .../components/chatdynamicservertool.mdx | 4 +- .../components/chatformatgrammarconfig.mdx | 4 +- .../components/chatformatjsonobjectconfig.mdx | 2 +- .../components/chatformatjsonschemaconfig.mdx | 4 +- .../components/chatformatpythonconfig.mdx | 2 +- .../components/chatformattextconfig.mdx | 2 +- .../components/chatfunctiontoolfunction.mdx | 6 +- .../chatfunctiontoolfunctionfunction.mdx | 8 +- .../components/chatjsonschemaconfig.mdx | 8 +- .../models/components/chatnamedtoolchoice.mdx | 4 +- .../chatnamedtoolchoicefunction.mdx | 2 +- docs/models/components/chatrequest.mdx | 82 ++--- .../components/chatrequestreasoning.mdx | 4 +- docs/models/components/chatresult.mdx | 18 +- .../components/chatsearchmodelsservertool.mdx | 4 +- .../components/chatservertoolchoice.mdx | 2 +- docs/models/components/chatstreamchoice.mdx | 8 +- docs/models/components/chatstreamchunk.mdx | 20 +- .../components/chatstreamchunkerror.mdx | 6 +- .../components/chatstreamchunkmetadata.mdx | 4 +- docs/models/components/chatstreamdelta.mdx | 14 +- .../components/chatstreamingresponse.mdx | 2 +- docs/models/components/chatstreamoptions.mdx | 2 +- docs/models/components/chatstreamtoolcall.mdx | 8 +- .../components/chatstreamtoolcallfunction.mdx | 4 +- docs/models/components/chatsystemmessage.mdx | 8 +- .../chatsystemmessageconfigurationupdate.mdx | 2 +- docs/models/components/chattokenlogprob.mdx | 8 +- docs/models/components/chattokenlogprobs.mdx | 4 +- .../components/chattokenlogprobtoplogprob.mdx | 6 +- docs/models/components/chattoolcall.mdx | 6 +- .../components/chattoolcallfunction.mdx | 4 +- docs/models/components/chattoolmessage.mdx | 6 +- docs/models/components/chatusage.mdx | 18 +- .../chatusagecompletiontokensdetails.mdx | 8 +- .../chatusageprompttokensdetails.mdx | 8 +- docs/models/components/chatusermessage.mdx | 6 +- .../components/chatwebsearchshorthand.mdx | 26 +- docs/models/components/choice.mdx | 10 +- .../codeinterpretercallcodedeltaevent.mdx | 10 +- .../codeinterpretercallcodedoneevent.mdx | 10 +- .../codeinterpretercallcompletedevent.mdx | 8 +- .../codeinterpretercallinprogressevent.mdx | 8 +- .../codeinterpretercallinterpretingevent.mdx | 8 +- .../components/codeinterpreterfileoutput.mdx | 20 +- .../components/codeinterpreterimageoutput.mdx | 4 +- .../components/codeinterpreterlogsoutput.mdx | 4 +- .../components/codeinterpreterservertool.mdx | 4 +- .../models/components/codexlocalshelltool.mdx | 2 +- docs/models/components/compactionitem.mdx | 8 +- docs/models/components/compoundfilter.mdx | 4 +- .../components/computeruseservertool.mdx | 8 +- .../components/configurationupdateitem.mdx | 6 +- .../configurationupdatereasoning.mdx | 2 +- .../components/conflictresponseerrordata.mdx | 6 +- docs/models/components/containerauto.mdx | 6 +- .../components/containerautoenvironment.mdx | 6 +- docs/models/components/containerfile.mdx | 14 +- .../components/containerfilelistresponse.mdx | 10 +- .../containernetworkpolicyallowlist.mdx | 4 +- .../containernetworkpolicydisabled.mdx | 2 +- .../containerreferenceenvironment.mdx | 8 +- docs/models/components/contentcompaction.mdx | 8 +- .../components/contentencryptedcontent.mdx | 6 +- .../components/contentfilterbuiltinentry.mdx | 8 +- .../contentfilterbuiltinentryinput.mdx | 8 +- docs/models/components/contentfilterentry.mdx | 6 +- docs/models/components/contentimageurl.mdx | 4 +- .../components/contentimageurlimageurl.mdx | 2 +- .../components/contentpartaddedevent.mdx | 12 +- docs/models/components/contentpartaudio.mdx | 4 +- .../components/contentpartdoneevent.mdx | 12 +- docs/models/components/contentpartimage.mdx | 4 +- .../components/contentpartimageimageurl.mdx | 2 +- .../components/contentpartinputaudio.mdx | 4 +- .../components/contentpartinputfile.mdx | 4 +- .../components/contentpartinputvideo.mdx | 4 +- docs/models/components/contentpartvideo.mdx | 4 +- .../components/contentredactedthinking.mdx | 4 +- .../components/contentservertooluse.mdx | 10 +- docs/models/components/contenttext.mdx | 4 +- docs/models/components/contentthinking.mdx | 6 +- .../components/contenttoolreference.mdx | 4 +- docs/models/components/contenttoolresult.mdx | 10 +- docs/models/components/contenttooluse.mdx | 10 +- docs/models/components/contenttoplogprob.mdx | 6 +- .../components/contentwebsearchtoolresult.mdx | 8 +- .../contentwebsearchtoolresulterror.mdx | 4 +- .../components/contextcompactionitem.mdx | 8 +- .../components/contextcompressionplugin.mdx | 6 +- docs/models/components/contextmanagement.mdx | 2 +- docs/models/components/contradiction.mdx | 4 +- docs/models/components/costdetails.mdx | 8 +- .../components/createbyokkeyrequest.mdx | 26 +- .../components/createbyokkeyresponse.mdx | 2 +- .../components/createenduserrequest.mdx | 6 +- .../components/createguardrailrequest.mdx | 44 +-- .../components/createguardrailresponse.mdx | 2 +- .../models/components/createinternrequest.mdx | 12 +- .../createobservabilitydestinationrequest.mdx | 26 +- ...createobservabilitydestinationresponse.mdx | 2 +- .../createpresetfrominferenceresponse.mdx | 2 +- .../createprivateendpointrequest.mdx | 16 +- ...teendpointvalidationfailedresponsedata.mdx | 4 +- ...eendpointvalidationfailedresponseerror.mdx | 4 +- .../createscimgroupmappingrequest.mdx | 6 +- .../createscimgroupmappingresponse.mdx | 2 +- .../components/createscimsyncjobresponse.mdx | 2 +- .../components/createworkspacerequest.mdx | 24 +- .../components/createworkspaceresponse.mdx | 2 +- docs/models/components/customtool.mdx | 10 +- .../customtoolcallinputdeltaevent.mdx | 10 +- .../customtoolcallinputdoneevent.mdx | 10 +- docs/models/components/customtoolcallitem.mdx | 16 +- .../components/customtoolcalloutputitem.mdx | 8 +- ...stomtoolcalloutputitemoutputinputimage.mdx | 8 +- docs/models/components/dabenchmarkentry.mdx | 10 +- docs/models/components/datetimeservertool.mdx | 4 +- .../components/datetimeservertoolconfig.mdx | 2 +- docs/models/components/debugevent.mdx | 6 +- docs/models/components/debugeventdebug.mdx | 4 +- docs/models/components/debugeventtimings.mdx | 6 +- docs/models/components/decisions.mdx | 6 +- .../components/decisionschoiceanswer.mdx | 8 +- .../components/decisionschoicequestion.mdx | 6 +- .../models/components/decisionsnoulanswer.mdx | 4 +- .../components/decisionsnoulquestion.mdx | 6 +- .../decisionsnoulquestioncriteria.mdx | 4 +- docs/models/components/decisionsrequest.mdx | 14 +- docs/models/components/decisionsresponse.mdx | 10 +- .../components/decisionsresponseusage.mdx | 6 +- .../components/decisionsscoreanswer.mdx | 10 +- .../components/decisionsscorequestion.mdx | 6 +- docs/models/components/defaultparameters.mdx | 12 +- .../components/deletebyokkeyresponse.mdx | 2 +- .../components/deleteguardrailresponse.mdx | 2 +- .../models/components/deleteinternrequest.mdx | 2 +- .../components/deleteinternresponse.mdx | 2 +- ...deleteobservabilitydestinationresponse.mdx | 2 +- .../deleteprivateendpointresponse.mdx | 2 +- .../deleteprivateendpointresponsedata.mdx | 2 +- .../deletescimgroupmappingresponse.mdx | 2 +- .../deleteworkspacebudgetresponse.mdx | 2 +- .../components/deleteworkspaceresponse.mdx | 2 +- docs/models/components/easyinputmessage.mdx | 8 +- .../easyinputmessagecontentinputimage.mdx | 8 +- .../edgenetworktimeoutresponseerrordata.mdx | 6 +- .../components/editclearthinking20251015.mdx | 4 +- .../components/editcleartooluses20250919.mdx | 12 +- .../models/components/editcompact20260112.mdx | 8 +- docs/models/components/embeddings.mdx | 6 +- docs/models/components/endpointinfo.mdx | 6 +- docs/models/components/endpointsmetadata.mdx | 4 +- docs/models/components/enduser.mdx | 12 +- docs/models/components/enduserresponse.mdx | 2 +- docs/models/components/enumcapability.mdx | 4 +- docs/models/components/errorevent.mdx | 10 +- docs/models/components/failedmodel.mdx | 6 +- docs/models/components/filecitation.mdx | 8 +- docs/models/components/fileparserplugin.mdx | 6 +- docs/models/components/filepath.mdx | 6 +- .../components/filesearchservertool.mdx | 10 +- docs/models/components/filesservertool.mdx | 4 +- docs/models/components/filters.mdx | 6 +- .../components/forbiddenresponseerrordata.mdx | 6 +- docs/models/components/formatgrammar.mdx | 6 +- .../components/formatjsonobjectconfig.mdx | 2 +- .../components/formatjsonschemaconfig.mdx | 10 +- docs/models/components/formattext.mdx | 2 +- docs/models/components/formattextconfig.mdx | 2 +- docs/models/components/frameimage.mdx | 6 +- docs/models/components/frameimageimageurl.mdx | 2 +- .../components/freemodeldailyrequests.mdx | 6 +- .../components/functioncallargsdeltaevent.mdx | 10 +- .../components/functioncallargsdoneevent.mdx | 12 +- docs/models/components/functioncallitem.mdx | 20 +- .../functioncallitemsubagentitem.mdx | 4 +- .../components/functioncalloutputitem.mdx | 10 +- ...functioncalloutputitemoutputinputimage.mdx | 8 +- .../components/fusionanalysisresult.mdx | 10 +- .../fusioncallanalysiscompletedevent.mdx | 10 +- .../fusioncallanalysisinprogressevent.mdx | 12 +- .../components/fusioncallcompletedevent.mdx | 8 +- .../components/fusioncallinprogressevent.mdx | 8 +- .../components/fusioncallpaneladdedevent.mdx | 10 +- .../fusioncallpanelcompletedevent.mdx | 12 +- .../components/fusioncallpaneldeltaevent.mdx | 12 +- .../components/fusioncallpanelfailedevent.mdx | 14 +- .../fusioncallpanelreasoningdeltaevent.mdx | 12 +- docs/models/components/fusionplugin.mdx | 14 +- docs/models/components/fusionplugintool.mdx | 4 +- .../components/fusionservertoolconfig.mdx | 16 +- .../fusionservertoolconfigreasoning.mdx | 4 +- .../components/fusionservertoolconfigtool.mdx | 4 +- .../components/fusionservertoolopenrouter.mdx | 4 +- docs/models/components/fusionsource.mdx | 4 +- .../gatewaytimeoutresponseerrordata.mdx | 6 +- .../components/generationcontentdata.mdx | 6 +- .../generationcontentdataoutput.mdx | 4 +- .../components/generationcontenterror.mdx | 10 +- .../generationcontenterrorattempt.mdx | 8 +- .../components/generationcontentresponse.mdx | 2 +- docs/models/components/generationresponse.mdx | 2 +- .../components/generationresponsedata.mdx | 90 +++--- docs/models/components/getbyokkeyresponse.mdx | 2 +- .../components/getguardrailresponse.mdx | 2 +- .../getobservabilitydestinationresponse.mdx | 2 +- docs/models/components/getpresetresponse.mdx | 2 +- .../components/getpresetversionresponse.mdx | 2 +- .../getscimgroupmappingresponse.mdx | 2 +- .../components/getscimsyncjobresponse.mdx | 2 +- docs/models/components/gettoolresponse.mdx | 2 +- .../components/getworkspacebudgetresponse.mdx | 4 +- .../components/getworkspaceresponse.mdx | 2 +- .../components/goneresponseerrordata.mdx | 6 +- docs/models/components/guardrail.mdx | 50 +-- docs/models/components/image.mdx | 4 +- docs/models/components/imageendpoint.mdx | 14 +- .../components/imagegencallcompletedevent.mdx | 8 +- .../imagegencallgeneratingevent.mdx | 8 +- .../imagegencallinprogressevent.mdx | 8 +- .../imagegencallpartialimageevent.mdx | 12 +- .../components/imagegencompletedevent.mdx | 10 +- docs/models/components/imagegeneration.mdx | 6 +- .../imagegenerationproviderpreferences.mdx | 12 +- ...gegenerationproviderpreferencesoptions.mdx | 292 +++++++++--------- .../components/imagegenerationrequest.mdx | 34 +- .../components/imagegenerationresponse.mdx | 6 +- .../imagegenerationresponsedata.mdx | 4 +- .../components/imagegenerationservertool.mdx | 22 +- .../imagegenerationservertoolconfig.mdx | 4 +- .../imagegenerationservertoolopenrouter.mdx | 4 +- .../components/imagegenerationusage.mdx | 26 +- ...generationusagecompletiontokensdetails.mdx | 6 +- ...magegenerationusageprompttokensdetails.mdx | 10 +- .../imagegenerationusageservertooluse.mdx | 6 +- .../components/imagegenpartialimageevent.mdx | 6 +- .../components/imagegenstreamerrorevent.mdx | 4 +- .../imagegenstreamerroreventerror.mdx | 8 +- .../components/imagegentextchunkevent.mdx | 6 +- .../components/imagemodelarchitecture.mdx | 4 +- .../imagemodelendpointsresponse.mdx | 4 +- docs/models/components/imagemodellistitem.mdx | 16 +- .../components/imagemodelslistresponse.mdx | 2 +- docs/models/components/imagepricingentry.mdx | 8 +- .../components/imagestreamingresponse.mdx | 2 +- docs/models/components/incompletedetails.mdx | 2 +- docs/models/components/input1.mdx | 2 +- docs/models/components/input2.mdx | 2 +- docs/models/components/inputaudio.mdx | 4 +- .../components/inputaudioinputaudio.mdx | 4 +- docs/models/components/inputfile.mdx | 10 +- docs/models/components/inputimage.mdx | 8 +- docs/models/components/inputimagemask.mdx | 4 +- docs/models/components/inputmessageitem.mdx | 8 +- .../inputmessageitemcontentinputimage.mdx | 8 +- docs/models/components/inputschema.mdx | 8 +- docs/models/components/inputsmessage.mdx | 12 +- docs/models/components/inputsreasoning.mdx | 16 +- docs/models/components/inputtext.mdx | 6 +- docs/models/components/inputtokensdetails.mdx | 4 +- docs/models/components/inputvideo.mdx | 6 +- docs/models/components/intern.mdx | 28 +- .../internalserverresponseerrordata.mdx | 6 +- .../components/internchatassistantmessage.mdx | 6 +- docs/models/components/internchatchoice.mdx | 6 +- .../components/internchatcompletionchunk.mdx | 16 +- .../internchatcompletionrequest.mdx | 10 +- docs/models/components/internchatdelta.mdx | 8 +- .../components/internchatdevelopermessage.mdx | 4 +- .../components/internchatechoedtoolcall.mdx | 4 +- .../internchatechoedtoolcallfunction.mdx | 4 +- docs/models/components/internchaterror.mdx | 6 +- .../components/internchaterrormetadata.mdx | 4 +- .../internchatprompttokensdetails.mdx | 2 +- .../components/internchatsteeredresponse.mdx | 4 +- .../components/internchatstreamerror.mdx | 6 +- .../internchatstreamingresponse.mdx | 2 +- .../components/internchatsystemmessage.mdx | 4 +- docs/models/components/internchattextpart.mdx | 4 +- docs/models/components/internchattoolcall.mdx | 8 +- .../components/internchattoolcallfunction.mdx | 4 +- .../components/internchattoolmessage.mdx | 6 +- docs/models/components/internchatusage.mdx | 10 +- .../components/internchatusermessage.mdx | 4 +- docs/models/components/interndaemonaccess.mdx | 4 +- .../interninvokeacceptedresponse.mdx | 4 +- .../models/components/interninvokerequest.mdx | 4 +- .../components/internlifecycleerrorerror.mdx | 6 +- .../internlifecycleerrormetadata.mdx | 4 +- docs/models/components/internlistresponse.mdx | 6 +- docs/models/components/itemreferenceitem.mdx | 4 +- docs/models/components/jevrouterplugin.mdx | 10 +- docs/models/components/keepall.mdx | 2 +- docs/models/components/key.mdx | 14 +- docs/models/components/keyassignment.mdx | 14 +- .../components/legacychatcontentvideo.mdx | 6 +- .../legacychatcontentvideoinput.mdx | 4 +- .../components/legacywebsearchservertool.mdx | 18 +- .../components/listbyokkeysresponse.mdx | 4 +- .../components/listendpointsresponse.mdx | 12 +- .../components/listendusersresponse.mdx | 4 +- .../components/listguardrailsresponse.mdx | 4 +- .../components/listkeyassignmentsresponse.mdx | 4 +- .../listmemberassignmentsresponse.mdx | 4 +- .../listobservabilitydestinationsresponse.mdx | 4 +- .../models/components/listpresetsresponse.mdx | 4 +- .../components/listpresetversionsresponse.mdx | 4 +- .../listprivateendpointsresponse.mdx | 2 +- .../listscimgroupmappingsresponse.mdx | 4 +- .../components/listscimgroupsresponse.mdx | 4 +- docs/models/components/listtoolsresponse.mdx | 6 +- .../components/listtoolsresponselinks.mdx | 2 +- .../listworkspacebudgetsresponse.mdx | 4 +- .../listworkspacemembersresponse.mdx | 4 +- .../components/listworkspacesresponse.mdx | 4 +- docs/models/components/localshellcallitem.mdx | 10 +- .../components/localshellcallitemaction.mdx | 12 +- .../components/localshellcalloutputitem.mdx | 8 +- docs/models/components/logprob.mdx | 8 +- docs/models/components/logprobs.mdx | 4 +- docs/models/components/logprobscontent.mdx | 8 +- .../components/managedprivateendpoint.mdx | 18 +- .../managedprivateendpointresponse.mdx | 2 +- docs/models/components/maxprice.mdx | 10 +- .../components/mcpapprovalrequestitem.mdx | 10 +- .../components/mcpapprovalresponseitem.mdx | 10 +- docs/models/components/mcpcallitem.mdx | 14 +- docs/models/components/mcphttperror.mdx | 6 +- docs/models/components/mcplisttoolsitem.mdx | 10 +- .../components/mcplisttoolsitemtool.mdx | 8 +- docs/models/components/mcpprotocolerror.mdx | 6 +- docs/models/components/mcpservertool.mdx | 18 +- .../components/mcptoolexecutionerror.mdx | 4 +- docs/models/components/memberassignment.mdx | 12 +- docs/models/components/message.mdx | 16 +- .../messagesadvisortoolresultblock.mdx | 6 +- .../messagesbashtoolresultblock.mdx | 10 +- .../messagesbashtoolresultblockfile.mdx | 12 +- .../components/messagesfallbackparam.mdx | 4 +- .../components/messagesmessageparam.mdx | 8 +- .../components/messagesoutputconfig.mdx | 6 +- .../components/messagesoutputconfigformat.mdx | 4 +- docs/models/components/messagesrequest.mdx | 54 ++-- .../components/messagesrequestmetadata.mdx | 2 +- .../models/components/messagesrequesttool.mdx | 4 +- .../messagessearchmodelsservertool.mdx | 4 +- .../messagesshelltoolresultblock.mdx | 10 +- .../messagesshelltoolresultblockfile.mdx | 12 +- .../components/messagestooladditionblock.mdx | 6 +- ...stooladditionblocktoolmcptoolreference.mdx | 6 +- ...oladditionblocktoolmcptoolsetreference.mdx | 4 +- ...agestooladditionblocktooltoolreference.mdx | 4 +- .../components/messagestoolremovalblock.mdx | 6 +- ...estoolremovalblocktoolmcptoolreference.mdx | 6 +- ...oolremovalblocktoolmcptoolsetreference.mdx | 4 +- ...sagestoolremovalblocktooltoolreference.mdx | 4 +- docs/models/components/mismatchbehavior.mdx | 2 +- docs/models/components/model.mdx | 40 +-- docs/models/components/modelaliastarget.mdx | 4 +- docs/models/components/modelarchitecture.mdx | 10 +- docs/models/components/modelbenchmarks.mdx | 4 +- docs/models/components/modellinks.mdx | 2 +- docs/models/components/modelreasoning.mdx | 10 +- docs/models/components/modelresponse.mdx | 2 +- .../models/components/modelscountresponse.mdx | 2 +- .../components/modelscountresponsedata.mdx | 2 +- docs/models/components/modelslistresponse.mdx | 6 +- .../components/modelslistresponselinks.mdx | 2 +- docs/models/components/moderationplugin.mdx | 2 +- docs/models/components/multimodalmedia.mdx | 4 +- .../components/namespacefunctiontool.mdx | 18 +- docs/models/components/namespacetool.mdx | 8 +- docs/models/components/nativesupport.mdx | 6 +- docs/models/components/nativetools.mdx | 2 +- docs/models/components/never.mdx | 2 +- .../components/notfoundresponseerrordata.mdx | 6 +- docs/models/components/oauthjwks.mdx | 2 +- .../observabilityarizedestination.mdx | 32 +- .../observabilityarizedestinationconfig.mdx | 10 +- .../observabilitybraintrustdestination.mdx | 32 +- ...servabilitybraintrustdestinationconfig.mdx | 8 +- .../observabilityclickhousedestination.mdx | 32 +- ...servabilityclickhousedestinationconfig.mdx | 14 +- .../observabilitydatadogdestination.mdx | 32 +- .../observabilitydatadogdestinationconfig.mdx | 8 +- .../observabilityfilterrulegroup.mdx | 4 +- .../observabilityfilterrulesconfig.mdx | 4 +- ...observabilityfilterrulesconfignullable.mdx | 4 +- .../observabilitygrafanadestination.mdx | 32 +- .../observabilitygrafanadestinationconfig.mdx | 8 +- .../observabilitylangfusedestination.mdx | 32 +- ...observabilitylangfusedestinationconfig.mdx | 8 +- .../observabilitylangsmithdestination.mdx | 32 +- ...bservabilitylangsmithdestinationconfig.mdx | 10 +- .../observabilitynewrelicdestination.mdx | 32 +- ...observabilitynewrelicdestinationconfig.mdx | 6 +- .../observabilityopikdestination.mdx | 32 +- .../observabilityopikdestinationconfig.mdx | 8 +- .../observabilityotelcollectordestination.mdx | 32 +- ...vabilityotelcollectordestinationconfig.mdx | 4 +- .../observabilityposthogdestination.mdx | 32 +- .../observabilityposthogdestinationconfig.mdx | 6 +- .../observabilityrampdestination.mdx | 32 +- .../observabilityrampdestinationconfig.mdx | 6 +- .../components/observabilitys3destination.mdx | 32 +- .../observabilitys3destinationconfig.mdx | 18 +- .../observabilitysentrydestination.mdx | 32 +- .../observabilitysentrydestinationconfig.mdx | 6 +- .../observabilitysnowflakedestination.mdx | 32 +- ...bservabilitysnowflakedestinationconfig.mdx | 16 +- .../observabilityweavedestination.mdx | 32 +- .../observabilityweavedestinationconfig.mdx | 10 +- .../observabilitywebhookdestination.mdx | 32 +- .../observabilitywebhookdestinationconfig.mdx | 6 +- docs/models/components/openaifile.mdx | 16 +- docs/models/components/openaifiledeleted.mdx | 8 +- docs/models/components/openaifilelist.mdx | 12 +- .../openairesponsecustomtoolcall.mdx | 14 +- .../openairesponsecustomtoolcalloutput.mdx | 8 +- .../openairesponsefunctiontoolcall.mdx | 20 +- .../openairesponsefunctiontoolcalloutput.mdx | 10 +- ...airesponsefunctiontoolcallsubagentitem.mdx | 4 +- .../openairesponseinputmessageitem.mdx | 8 +- .../openairesponsesrefusalcontent.mdx | 4 +- .../components/openairesponsestoolchoice.mdx | 2 +- .../openairesponsestoolchoiceapplypatch.mdx | 2 +- .../openairesponsestoolchoicefunction.mdx | 4 +- .../openairesponsestoolchoiceshell.mdx | 2 +- .../components/openresponsescreatedevent.mdx | 6 +- .../components/openresponseserrorfield.mdx | 6 +- .../components/openresponseserrormetadata.mdx | 2 +- .../openresponseserrormetadataalignment.mdx | 4 +- .../openresponsesinprogressevent.mdx | 6 +- .../models/components/openresponsesresult.mdx | 76 ++--- .../openresponsesresulttoolfunction.mdx | 14 +- docs/models/components/openrouterfile.mdx | 16 +- .../components/openrouterfiledeleted.mdx | 6 +- docs/models/components/openrouterfilelist.mdx | 12 +- docs/models/components/openroutermetadata.mdx | 22 +- .../openrouterwebsearchservertool.mdx | 4 +- .../components/oranthropicbashtoolresult.mdx | 10 +- .../oranthropicbashtoolresultfile.mdx | 12 +- .../oranthropicservertooluseblock.mdx | 10 +- .../components/oranthropicshelltoolresult.mdx | 10 +- .../oranthropicshelltoolresultfile.mdx | 12 +- .../components/organizationsettings.mdx | 4 +- docs/models/components/outcomeexit.mdx | 6 +- docs/models/components/outcometimeout.mdx | 4 +- .../outputadvisorservertoolitem.mdx | 16 +- .../components/outputapplypatchcallitem.mdx | 10 +- .../outputapplypatchservertoolitem.mdx | 12 +- .../components/outputbashservertoolitem.mdx | 24 +- .../outputbashservertoolitemfile.mdx | 12 +- .../outputbrowseruseservertoolitem.mdx | 10 +- .../outputcodeinterpretercallitem.mdx | 14 +- .../outputcodeinterpreterservertoolitem.mdx | 16 +- .../components/outputcomputercallitem.mdx | 12 +- .../components/outputcustomtoolcallitem.mdx | 16 +- docs/models/components/outputdatetimeitem.mdx | 12 +- .../components/outputfilesearchcallitem.mdx | 8 +- .../outputfilesearchservertoolitem.mdx | 8 +- .../components/outputfilesservertoolitem.mdx | 20 +- .../components/outputfunctioncallitem.mdx | 20 +- .../outputfunctioncallitemsubagentitem.mdx | 4 +- .../components/outputfusionservertoolitem.mdx | 18 +- .../outputfusionservertoolitemresponse.mdx | 4 +- .../outputimagegenerationcallitem.mdx | 10 +- .../outputimagegenerationservertoolitem.mdx | 18 +- .../components/outputitemapplypatchcall.mdx | 12 +- .../outputitemcodeinterpretercall.mdx | 14 +- .../components/outputitemcustomtoolcall.mdx | 16 +- .../components/outputitemfilesearchcall.mdx | 8 +- .../components/outputitemfunctioncall.mdx | 16 +- .../outputitemimagegenerationcall.mdx | 8 +- .../models/components/outputitemreasoning.mdx | 12 +- .../components/outputitemwebsearchcall.mdx | 10 +- ...utputitemwebsearchcallactionfindinpage.mdx | 6 +- .../outputitemwebsearchcallactionopenpage.mdx | 4 +- .../outputitemwebsearchcallactionsearch.mdx | 8 +- .../components/outputmcpservertoolitem.mdx | 10 +- .../components/outputmemoryservertoolitem.mdx | 12 +- docs/models/components/outputmessage.mdx | 12 +- docs/models/components/outputmessageitem.mdx | 12 +- .../models/components/outputreasoningitem.mdx | 16 +- .../outputsearchmodelsservertoolitem.mdx | 12 +- .../models/components/outputshellcallitem.mdx | 12 +- .../components/outputshellcallitemaction.mdx | 6 +- .../components/outputshellcalloutputitem.mdx | 18 +- .../outputshellcalloutputitemfile.mdx | 12 +- .../components/outputshellservertoolitem.mdx | 20 +- .../outputshellservertoolitemaction.mdx | 6 +- .../outputshellservertoolitemfile.mdx | 12 +- .../outputsubagentservertoolitem.mdx | 22 +- .../outputtexteditorservertoolitem.mdx | 10 +- .../models/components/outputtokensdetails.mdx | 2 +- .../components/outputtoolsearchcallitem.mdx | 12 +- .../outputtoolsearchservertoolitem.mdx | 10 +- .../outputwebfetchservertoolitem.mdx | 16 +- .../components/outputwebsearchcallitem.mdx | 10 +- ...utputwebsearchcallitemactionfindinpage.mdx | 6 +- .../outputwebsearchcallitemactionopenpage.mdx | 4 +- .../outputwebsearchcallitemactionsearch.mdx | 8 +- .../outputwebsearchservertoolitem.mdx | 10 +- .../outputwebsearchservertoolitemaction.mdx | 6 +- .../outputwebsearchservertoolitemsource.mdx | 4 +- docs/models/components/paretorouterplugin.mdx | 10 +- docs/models/components/partialcoverage.mdx | 4 +- .../payloadtoolargeresponseerrordata.mdx | 6 +- .../paymentrequiredresponseerrordata.mdx | 6 +- docs/models/components/pdfparseroptions.mdx | 2 +- docs/models/components/pendingsafetycheck.mdx | 6 +- .../components/percentilelatencycutoffs.mdx | 8 +- docs/models/components/percentilestats.mdx | 8 +- .../percentilethroughputcutoffs.mdx | 8 +- .../components/perflast30mbyworkload.mdx | 18 +- docs/models/components/perrequestlimits.mdx | 4 +- docs/models/components/pipelinestage.mdx | 14 +- docs/models/components/prediction.mdx | 4 +- .../components/predictioncontenttext.mdx | 4 +- docs/models/components/preset.mdx | 22 +- .../components/presetdesignatedversion.mdx | 16 +- .../presetwithdesignatedversion.mdx | 24 +- .../preview20250311websearchservertool.mdx | 18 +- .../components/previewwebsearchservertool.mdx | 18 +- .../previewwebsearchuserlocation.mdx | 10 +- docs/models/components/pricing.mdx | 32 +- docs/models/components/pricingoverride.mdx | 22 +- docs/models/components/privateendpoint.mdx | 24 +- .../components/privateendpointactivation.mdx | 2 +- .../components/privateendpointcheck.mdx | 12 +- .../components/privateendpointpricing.mdx | 4 +- .../components/privateendpointresponse.mdx | 2 +- .../components/privateendpointsummary.mdx | 14 +- .../components/privateendpointvalidation.mdx | 4 +- .../privateendpointvalidationnullable.mdx | 4 +- .../privateendpointvalidationresponse.mdx | 2 +- docs/models/components/progress.mdx | 6 +- .../components/promptcachebreakpoint.mdx | 2 +- docs/models/components/promptcacheoptions.mdx | 4 +- docs/models/components/provideroptions.mdx | 292 +++++++++--------- .../provideroverloadedresponseerrordata.mdx | 6 +- .../models/components/providerpreferences.mdx | 28 +- docs/models/components/providerresponse.mdx | 16 +- docs/models/components/providersortconfig.mdx | 4 +- .../components/provisioninternresponse.mdx | 2 +- docs/models/components/publicendpoint.mdx | 48 +-- docs/models/components/publicpricing.mdx | 32 +- docs/models/components/rangecapability.mdx | 6 +- docs/models/components/rankingoptions.mdx | 4 +- docs/models/components/rankingsdailyitem.mdx | 6 +- docs/models/components/rankingsdailymeta.mdx | 8 +- .../components/rankingsdailyresponse.mdx | 4 +- docs/models/components/reasoningconfig.mdx | 12 +- .../models/components/reasoningdeltaevent.mdx | 12 +- .../components/reasoningdetailencrypted.mdx | 10 +- .../reasoningdetailservertoolcall.mdx | 16 +- .../components/reasoningdetailsummary.mdx | 10 +- .../models/components/reasoningdetailtext.mdx | 12 +- docs/models/components/reasoningdoneevent.mdx | 12 +- docs/models/components/reasoningitem.mdx | 16 +- .../reasoningsummarypartaddedevent.mdx | 12 +- .../reasoningsummarypartdoneevent.mdx | 12 +- .../components/reasoningsummarytext.mdx | 4 +- .../reasoningsummarytextdeltaevent.mdx | 12 +- .../reasoningsummarytextdoneevent.mdx | 12 +- .../components/reasoningtextcontent.mdx | 4 +- docs/models/components/refusal.mdx | 8 +- docs/models/components/refusaldeltaevent.mdx | 12 +- docs/models/components/refusaldoneevent.mdx | 12 +- docs/models/components/refusaltoplogprob.mdx | 6 +- docs/models/components/request.mdx | 4 +- .../requesttimeoutresponseerrordata.mdx | 6 +- docs/models/components/requireapproval.mdx | 4 +- docs/models/components/rerank.mdx | 6 +- .../components/responsehealingplugin.mdx | 4 +- docs/models/components/responseoutputtext.mdx | 8 +- .../responseoutputtexttoplogprob.mdx | 6 +- docs/models/components/responsesrequest.mdx | 78 ++--- .../responsesrequesttoolfunction.mdx | 14 +- .../components/responsesstreamingresponse.mdx | 2 +- docs/models/components/result.mdx | 8 +- docs/models/components/resulterror.mdx | 8 +- docs/models/components/routerattempt.mdx | 6 +- docs/models/components/routerparams.mdx | 8 +- docs/models/components/rule.mdx | 6 +- docs/models/components/scimgroup.mdx | 12 +- docs/models/components/scimgroupmapping.mdx | 14 +- docs/models/components/scimsyncjob.mdx | 16 +- .../searchmodelsservertoolconfig.mdx | 2 +- .../searchmodelsservertoolopenrouter.mdx | 4 +- docs/models/components/security.mdx | 2 +- docs/models/components/servertool.mdx | 30 +- docs/models/components/servertooldetails.mdx | 30 +- docs/models/components/servertoolengine.mdx | 18 +- .../models/components/servertoolinputname.mdx | 6 +- .../components/servertoolnativemodel.mdx | 4 +- .../components/servertoolnativesupport.mdx | 4 +- .../components/servertooloutputname.mdx | 6 +- docs/models/components/servertoolprice.mdx | 8 +- .../components/servertoolusedetails.mdx | 6 +- .../serviceunavailableresponseerrordata.mdx | 6 +- docs/models/components/sessioncostitem.mdx | 10 +- docs/models/components/sessioncostmeta.mdx | 8 +- .../models/components/sessioncostresponse.mdx | 4 +- docs/models/components/shellcallitem.mdx | 14 +- .../models/components/shellcallitemaction.mdx | 6 +- .../components/shellcalloutputcontent.mdx | 8 +- .../models/components/shellcalloutputitem.mdx | 18 +- .../components/shellcalloutputitemfile.mdx | 12 +- docs/models/components/shellservertool.mdx | 2 +- .../components/shellservertoolconfig.mdx | 4 +- .../components/shellservertoolopenrouter.mdx | 4 +- .../components/signinterndaemonrequest.mdx | 2 +- .../components/signinterndaemonresponse.mdx | 6 +- docs/models/components/sourcecontent.mdx | 4 +- .../components/speechinputreferenceaudio.mdx | 4 +- .../speechinputreferenceaudioinput.mdx | 6 +- .../components/speechinputreferenceimage.mdx | 4 +- .../speechinputreferenceimageinput.mdx | 2 +- .../components/speechinputreferencetext.mdx | 4 +- docs/models/components/speechrequest.mdx | 22 +- .../components/speechrequestprovider.mdx | 6 +- docs/models/components/speechturn.mdx | 6 +- docs/models/components/stance.mdx | 4 +- .../stopservertoolswhenfinishreasonis.mdx | 4 +- .../stopservertoolswhenhastoolcall.mdx | 4 +- .../components/stopservertoolswhenmaxcost.mdx | 4 +- .../stopservertoolswhenmaxtokensused.mdx | 4 +- .../stopservertoolswhenstepcountis.mdx | 4 +- .../components/storedprompttemplate.mdx | 4 +- .../streameventsresponsecompleted.mdx | 6 +- .../components/streameventsresponsefailed.mdx | 6 +- .../streameventsresponseincomplete.mdx | 6 +- .../streameventsresponseoutputitemadded.mdx | 8 +- .../streameventsresponseoutputitemdone.mdx | 8 +- docs/models/components/streamlogprob.mdx | 8 +- .../components/streamlogprobtoplogprob.mdx | 6 +- docs/models/components/stt.mdx | 6 +- docs/models/components/sttentity.mdx | 8 +- .../models/components/sttinlineinputaudio.mdx | 4 +- docs/models/components/sttrequest.mdx | 24 +- docs/models/components/sttrequestprovider.mdx | 6 +- docs/models/components/sttresponse.mdx | 20 +- docs/models/components/sttsegment.mdx | 26 +- docs/models/components/stturlinputaudio.mdx | 4 +- docs/models/components/sttusage.mdx | 10 +- docs/models/components/sttword.mdx | 16 +- docs/models/components/subagentnestedtool.mdx | 6 +- docs/models/components/subagentreasoning.mdx | 4 +- .../components/subagentservertoolconfig.mdx | 20 +- .../subagentservertoolopenrouter.mdx | 4 +- .../submitgenerationfeedbackrequest.mdx | 6 +- .../submitgenerationfeedbackresponse.mdx | 2 +- .../submitgenerationfeedbackresponsedata.mdx | 2 +- .../components/suspendinternresponse.mdx | 2 +- .../components/switchyardrouterplugin.mdx | 6 +- docs/models/components/taskbudget.mdx | 6 +- .../components/taskclassificationitem.mdx | 16 +- .../taskclassificationmacrocategory.mdx | 8 +- .../components/taskclassificationmodel.mdx | 6 +- .../components/taskclassificationresponse.mdx | 2 +- .../taskclassificationresponsedata.mdx | 8 +- docs/models/components/textdeltaevent.mdx | 14 +- docs/models/components/textdoneevent.mdx | 14 +- docs/models/components/textextendedconfig.mdx | 4 +- docs/models/components/textgeneration.mdx | 6 +- docs/models/components/thinkingadaptive.mdx | 6 +- .../components/thinkingbetweentools.mdx | 2 +- docs/models/components/thinkingdisabled.mdx | 2 +- docs/models/components/thinkingenabled.mdx | 8 +- .../components/tokenexchangerequest.mdx | 12 +- .../components/tokenexchangeresponse.mdx | 10 +- .../models/components/tooladvisor20260301.mdx | 16 +- docs/models/components/toolbash20250124.mdx | 6 +- docs/models/components/toolcall.mdx | 8 +- docs/models/components/toolchoiceallowed.mdx | 6 +- docs/models/components/toolchoiceany.mdx | 4 +- docs/models/components/toolchoiceauto.mdx | 4 +- docs/models/components/toolchoicenone.mdx | 2 +- docs/models/components/toolchoicesupport.mdx | 8 +- docs/models/components/toolchoicetool.mdx | 6 +- docs/models/components/toolcustom.mdx | 14 +- docs/models/components/toolsearchcallitem.mdx | 12 +- .../components/toolsearchoutputitem.mdx | 12 +- .../components/toolsearchoutputitemtool.mdx | 4 +- .../toolsearchoutputitemtoolfunction.mdx | 14 +- .../components/toolsearchservertool.mdx | 4 +- .../components/toolsearchservertoolconfig.mdx | 2 +- .../components/tooltexteditor20250124.mdx | 6 +- .../components/toolwebsearch20250305.mdx | 14 +- .../components/toolwebsearch20260209.mdx | 16 +- .../toomanyrequestsresponseerrordata.mdx | 6 +- docs/models/components/topproviderinfo.mdx | 6 +- docs/models/components/tournamentstats.mdx | 10 +- docs/models/components/traceconfig.mdx | 12 +- docs/models/components/triggerinputtokens.mdx | 4 +- docs/models/components/tts.mdx | 6 +- .../unauthorizedresponseerrordata.mdx | 6 +- .../components/unifiedbenchmarkpricing.mdx | 4 +- .../components/unifiedbenchmarksaaitem.mdx | 14 +- .../components/unifiedbenchmarksdaitem.mdx | 20 +- .../components/unifiedbenchmarksmeta.mdx | 14 +- .../components/unifiedbenchmarksoritem.mdx | 18 +- .../components/unifiedbenchmarksresponse.mdx | 4 +- .../unifiedbenchmarkssearchitem.mdx | 26 +- .../unifiedbenchmarkssearchrunconfig.mdx | 6 +- docs/models/components/uniqueinsight.mdx | 4 +- docs/models/components/unknown.mdx | 6 +- .../unprocessableentityresponseerrordata.mdx | 6 +- .../components/updatebyokkeyrequest.mdx | 22 +- .../components/updatebyokkeyresponse.mdx | 2 +- .../components/updateenduserrequest.mdx | 2 +- .../components/updateguardrailrequest.mdx | 42 +-- .../components/updateguardrailresponse.mdx | 2 +- .../models/components/updateinternrequest.mdx | 8 +- .../updateobservabilitydestinationrequest.mdx | 22 +- ...updateobservabilitydestinationresponse.mdx | 2 +- .../updateorganizationsettingsrequest.mdx | 2 +- .../updateprivateendpointpricingrequest.mdx | 2 +- .../updateprivateendpointrequest.mdx | 8 +- .../updatescimgroupmappingrequest.mdx | 2 +- .../updatescimgroupmappingresponse.mdx | 2 +- .../components/updateworkspacerequest.mdx | 24 +- .../components/updateworkspaceresponse.mdx | 2 +- docs/models/components/upscalefactor.mdx | 4 +- .../upsertworkspacebudgetrequest.mdx | 4 +- .../upsertworkspacebudgetresponse.mdx | 4 +- docs/models/components/upstream.mdx | 4 +- docs/models/components/urlcitation.mdx | 12 +- docs/models/components/usage.mdx | 18 +- docs/models/components/usagecostdetails.mdx | 8 +- docs/models/components/userlocation.mdx | 10 +- .../validateprivateendpointrequest.mdx | 2 +- .../components/vaulteffectivesecret.mdx | 10 +- .../vaulteffectivesecretlistresponse.mdx | 4 +- docs/models/components/vaultsecret.mdx | 8 +- .../components/vaultsecretcopyrequest.mdx | 2 +- .../components/vaultsecretcopyresponse.mdx | 2 +- .../components/vaultsecretlistresponse.mdx | 4 +- .../models/components/vaultsecretresponse.mdx | 2 +- .../components/vaultsecretwriterequest.mdx | 4 +- docs/models/components/videogeneration.mdx | 6 +- .../components/videogenerationrequest.mdx | 36 +-- .../videogenerationrequestoptions.mdx | 292 +++++++++--------- .../videogenerationrequestprovider.mdx | 2 +- .../components/videogenerationresponse.mdx | 14 +- .../components/videogenerationusage.mdx | 4 +- docs/models/components/videomodel.mdx | 34 +- .../components/videomodelslistresponse.mdx | 2 +- docs/models/components/videourl.mdx | 2 +- docs/models/components/webfetchplugin.mdx | 10 +- docs/models/components/webfetchservertool.mdx | 4 +- .../components/webfetchservertoolconfig.mdx | 10 +- .../websearchcallcompletedevent.mdx | 8 +- .../websearchcallinprogressevent.mdx | 8 +- .../websearchcallsearchingevent.mdx | 8 +- docs/models/components/websearchcitation.mdx | 8 +- docs/models/components/websearchconfig.mdx | 22 +- .../components/websearchdomainfilter.mdx | 6 +- docs/models/components/websearchplugin.mdx | 22 +- .../models/components/websearchservertool.mdx | 18 +- .../components/websearchservertoolconfig.mdx | 22 +- .../websearchservertoolopenrouter.mdx | 4 +- docs/models/components/websearchsource.mdx | 4 +- .../components/websearchuserlocation.mdx | 10 +- .../websearchuserlocationservertool.mdx | 10 +- docs/models/components/workspace.mdx | 36 +-- docs/models/components/workspacebudget.mdx | 12 +- docs/models/components/workspacemember.mdx | 10 +- docs/models/components/xsearchoptions.mdx | 12 +- .../activateprivateendpointrequest.mdx | 2 +- .../bulkaddworkspacemembersrequest.mdx | 4 +- .../bulkassignkeystoguardrailrequest.mdx | 4 +- .../bulkassignmemberstoguardrailrequest.mdx | 4 +- .../bulkremoveworkspacemembersrequest.mdx | 4 +- .../bulkunassignkeysfromguardrailrequest.mdx | 4 +- ...ulkunassignmembersfromguardrailrequest.mdx | 4 +- .../operations/classifierdimensions.mdx | 6 +- docs/models/operations/classifierfilters.mdx | 4 +- .../operations/classifierfiltersfilter.mdx | 6 +- docs/models/operations/contentimageurl.mdx | 4 +- docs/models/operations/contenttext.mdx | 4 +- .../copyvaultsecretstointernrequest.mdx | 4 +- ...createaudiotranscriptionsmultipartfile.mdx | 4 +- ...ateaudiotranscriptionsmultipartrequest.mdx | 26 +- .../operations/createauthkeyscodedata.mdx | 6 +- .../operations/createauthkeyscoderequest.mdx | 16 +- .../operations/createauthkeyscoderesponse.mdx | 2 +- .../operations/createembeddingsdata.mdx | 6 +- .../operations/createembeddingsrequest.mdx | 18 +- .../createembeddingsresponsebody.mdx | 10 +- .../operations/createembeddingsusage.mdx | 12 +- .../createinternchatcompletionrequest.mdx | 4 +- .../createinternchatcompletionresponse.mdx | 4 +- .../models/operations/createinternrequest.mdx | 4 +- docs/models/operations/createkeysdata.mdx | 46 +-- docs/models/operations/createkeysrequest.mdx | 16 +- docs/models/operations/createkeysresponse.mdx | 4 +- .../createpresetschatcompletionsrequest.mdx | 4 +- .../createpresetsmessagesrequest.mdx | 4 +- .../createpresetsresponsesrequest.mdx | 4 +- .../createprivateendpointrequest.mdx | 4 +- .../models/operations/creatererankrequest.mdx | 16 +- .../operations/creatererankresponsebody.mdx | 10 +- docs/models/operations/creatererankusage.mdx | 6 +- .../operations/createresponsesrequest.mdx | 4 +- .../operations/createscimsyncjobresponse.mdx | 4 +- docs/models/operations/deletebatchrequest.mdx | 2 +- .../operations/deletebyokkeyrequest.mdx | 2 +- .../operations/deleteenduserrequest.mdx | 6 +- docs/models/operations/deletefilerequest.mdx | 6 +- .../operations/deleteguardrailrequest.mdx | 2 +- .../models/operations/deleteinternrequest.mdx | 4 +- .../deleteinternvaultsecretrequest.mdx | 4 +- docs/models/operations/deletekeysrequest.mdx | 2 +- docs/models/operations/deletekeysresponse.mdx | 2 +- .../deleteobservabilitydestinationrequest.mdx | 2 +- .../deleteprivateendpointrequest.mdx | 4 +- .../deletescimgroupmappingrequest.mdx | 4 +- .../operations/deletevaultsecretrequest.mdx | 2 +- .../deleteworkspacebudgetrequest.mdx | 4 +- .../operations/deleteworkspacerequest.mdx | 4 +- docs/models/operations/dimension.mdx | 4 +- .../disableprivateendpointrequest.mdx | 2 +- docs/models/operations/documentrequest.mdx | 4 +- docs/models/operations/documentresponse.mdx | 4 +- .../downloadcontainerfilecontentrequest.mdx | 4 +- .../operations/downloadfilecontentrequest.mdx | 6 +- .../enableprivateendpointrequest.mdx | 2 +- .../exchangeauthcodeforapikeyrequest.mdx | 6 +- .../exchangeauthcodeforapikeyresponse.mdx | 4 +- docs/models/operations/external.mdx | 4 +- docs/models/operations/filter.mdx | 8 +- .../operations/getanalyticsmetadata.mdx | 8 +- .../operations/getanalyticsmetaresponse.mdx | 2 +- .../operations/getapprankingsrequest.mdx | 14 +- .../operations/getapprankingsresponse.mdx | 2 +- docs/models/operations/getbatchesrequest.mdx | 2 +- .../operations/getbenchmarksrequest.mdx | 18 +- docs/models/operations/getbyokkeyrequest.mdx | 2 +- .../operations/getcontainerfilerequest.mdx | 4 +- docs/models/operations/getcreditsdata.mdx | 4 +- docs/models/operations/getcreditsresponse.mdx | 2 +- docs/models/operations/getcurrentkeydata.mdx | 46 +-- .../operations/getcurrentkeyresponse.mdx | 2 +- docs/models/operations/getenduserrequest.mdx | 6 +- .../operations/getfilemetadatarequest.mdx | 6 +- .../operations/getgenerationrequest.mdx | 2 +- .../models/operations/getguardrailrequest.mdx | 2 +- .../getinterndaemonaccessrequest.mdx | 2 +- .../operations/getinterndaemonrequest.mdx | 2 +- docs/models/operations/getinternrequest.mdx | 2 +- docs/models/operations/getkeydata.mdx | 46 +-- docs/models/operations/getkeyrequest.mdx | 2 +- docs/models/operations/getkeyresponse.mdx | 2 +- docs/models/operations/getmodelrequest.mdx | 4 +- docs/models/operations/getmodelsrequest.mdx | 58 ++-- docs/models/operations/getmodelsresponse.mdx | 2 +- .../getobservabilitydestinationrequest.mdx | 2 +- .../getorganizationsettingsresponse.mdx | 2 +- docs/models/operations/getpresetrequest.mdx | 2 +- .../operations/getpresetversionrequest.mdx | 4 +- .../operations/getprivateendpointrequest.mdx | 2 +- .../operations/getrankingsdailyrequest.mdx | 14 +- .../operations/getscimgroupmappingrequest.mdx | 2 +- .../operations/getscimsyncjobrequest.mdx | 2 +- .../operations/getsessioncostrequest.mdx | 10 +- .../operations/getsessioncostresponse.mdx | 2 +- .../gettaskclassificationsrequest.mdx | 2 +- docs/models/operations/gettoolrequest.mdx | 2 +- docs/models/operations/gettoolresponse.mdx | 4 +- docs/models/operations/gettoolsecurity.mdx | 2 +- .../operations/getuseractivityrequest.mdx | 10 +- docs/models/operations/getvideosrequest.mdx | 2 +- .../operations/getworkspacebudgetrequest.mdx | 4 +- .../models/operations/getworkspacerequest.mdx | 2 +- docs/models/operations/granularity.mdx | 4 +- docs/models/operations/imageurl.mdx | 2 +- docs/models/operations/input.mdx | 2 +- .../models/operations/invokeinternrequest.mdx | 4 +- .../operations/invokeinternresponse.mdx | 4 +- docs/models/operations/listbatchesrequest.mdx | 10 +- .../models/operations/listbatchesresponse.mdx | 2 +- .../models/operations/listbyokkeysrequest.mdx | 8 +- .../operations/listbyokkeysresponse.mdx | 2 +- .../operations/listcontainerfilesrequest.mdx | 6 +- docs/models/operations/listdata.mdx | 46 +-- .../listembeddingsmodelsrequest.mdx | 4 +- .../listembeddingsmodelsresponse.mdx | 2 +- .../operations/listendpointsrequest.mdx | 4 +- .../operations/listendpointsresponse.mdx | 2 +- .../operations/listendpointszdrresponse.mdx | 2 +- .../models/operations/listendusersrequest.mdx | 12 +- .../operations/listendusersresponse.mdx | 2 +- docs/models/operations/listfilesrequest.mdx | 16 +- docs/models/operations/listfilesresponse.mdx | 2 +- .../listgenerationcontentrequest.mdx | 2 +- .../listguardrailkeyassignmentsrequest.mdx | 6 +- .../listguardrailkeyassignmentsresponse.mdx | 2 +- .../listguardrailmemberassignmentsrequest.mdx | 6 +- ...listguardrailmemberassignmentsresponse.mdx | 2 +- .../operations/listguardrailsrequest.mdx | 6 +- .../operations/listguardrailsresponse.mdx | 2 +- .../listimagemodelendpointsrequest.mdx | 4 +- ...listinterneffectivevaultsecretsrequest.mdx | 6 +- docs/models/operations/listinternsrequest.mdx | 8 +- .../listinternvaultsecretsrequest.mdx | 6 +- .../operations/listkeyassignmentsrequest.mdx | 4 +- .../operations/listkeyassignmentsresponse.mdx | 2 +- .../listmemberassignmentsrequest.mdx | 4 +- .../listmemberassignmentsresponse.mdx | 2 +- .../operations/listmodelscountrequest.mdx | 2 +- .../operations/listmodelsuserrequest.mdx | 6 +- .../operations/listmodelsuserresponse.mdx | 2 +- .../operations/listmodelsusersecurity.mdx | 2 +- .../listobservabilitydestinationsrequest.mdx | 6 +- .../listobservabilitydestinationsresponse.mdx | 2 +- .../listorganizationmembersdata.mdx | 10 +- .../listorganizationmembersrequest.mdx | 4 +- .../listorganizationmembersresponse.mdx | 2 +- .../listorganizationmembersresponsebody.mdx | 4 +- docs/models/operations/listpresetsrequest.mdx | 4 +- .../models/operations/listpresetsresponse.mdx | 2 +- .../operations/listpresetversionsrequest.mdx | 6 +- .../operations/listpresetversionsresponse.mdx | 2 +- docs/models/operations/listprovidersdata.mdx | 14 +- .../operations/listprovidersresponse.mdx | 2 +- docs/models/operations/listrequest.mdx | 8 +- docs/models/operations/listresponse.mdx | 2 +- .../listscimgroupmappingsrequest.mdx | 4 +- .../listscimgroupmappingsresponse.mdx | 2 +- .../operations/listscimgroupsrequest.mdx | 8 +- .../operations/listscimgroupsresponse.mdx | 2 +- docs/models/operations/listtoolsrequest.mdx | 6 +- docs/models/operations/listtoolssecurity.mdx | 2 +- .../operations/listvaultsecretsrequest.mdx | 4 +- .../operations/listvideoscontentrequest.mdx | 4 +- .../listworkspacebudgetsrequest.mdx | 2 +- .../listworkspacemembersrequest.mdx | 6 +- .../listworkspacemembersresponse.mdx | 2 +- .../operations/listworkspacesrequest.mdx | 4 +- .../operations/listworkspacesresponse.mdx | 2 +- docs/models/operations/metadata.mdx | 6 +- docs/models/operations/metric.mdx | 8 +- docs/models/operations/operator.mdx | 4 +- docs/models/operations/orderby.mdx | 4 +- .../promotecontainerfilerequest.mdx | 4 +- .../models/operations/prompttokensdetails.mdx | 10 +- .../operations/provisioninternrequest.mdx | 2 +- .../models/operations/queryanalyticsdata2.mdx | 8 +- .../operations/queryanalyticsrequest.mdx | 20 +- .../operations/queryanalyticsresponse.mdx | 2 +- docs/models/operations/ratelimit.mdx | 8 +- docs/models/operations/result.mdx | 6 +- .../sendchatcompletionrequestrequest.mdx | 4 +- .../signinterndaemonaccessrequestrequest.mdx | 4 +- .../signinterndaemonaccessrequestresponse.mdx | 4 +- .../signinterndaemonrequestrequest.mdx | 4 +- .../signinterndaemonrequestresponse.mdx | 4 +- .../storeinternvaultsecretrequest.mdx | 6 +- .../operations/storevaultsecretrequest.mdx | 4 +- .../operations/suspendinternrequest.mdx | 2 +- docs/models/operations/timerange.mdx | 4 +- .../operations/updatebyokkeyrequest.mdx | 4 +- .../operations/updateenduserrequest.mdx | 8 +- .../operations/updateguardrailrequest.mdx | 4 +- .../models/operations/updateinternrequest.mdx | 4 +- docs/models/operations/updatekeysdata.mdx | 46 +-- docs/models/operations/updatekeysrequest.mdx | 4 +- .../operations/updatekeysrequestbody.mdx | 10 +- docs/models/operations/updatekeysresponse.mdx | 2 +- .../updateobservabilitydestinationrequest.mdx | 4 +- .../updateorganizationsettingsresponse.mdx | 2 +- .../updateprivateendpointpricingrequest.mdx | 4 +- .../updateprivateendpointrequest.mdx | 4 +- .../updatescimgroupmappingrequest.mdx | 4 +- .../operations/updateworkspacerequest.mdx | 4 +- docs/models/operations/uploadfilefile.mdx | 4 +- docs/models/operations/uploadfilerequest.mdx | 6 +- .../operations/uploadfilerequestbody.mdx | 2 +- .../upsertworkspacebudgetrequest.mdx | 6 +- .../validateprivateendpointrequest.mdx | 4 +- .../sdkerrors/badgatewayresponseerror.mdx | 6 +- .../sdkerrors/badrequestresponseerror.mdx | 6 +- docs/models/sdkerrors/batcherrorresponse.mdx | 2 +- .../batchpaymentrequiredresponseerror.mdx | 24 +- .../sdkerrors/conflictresponseerror.mdx | 6 +- ...eendpointvalidationfailedresponseerror.mdx | 4 +- .../edgenetworktimeoutresponseerror.mdx | 6 +- .../sdkerrors/forbiddenresponseerror.mdx | 6 +- .../sdkerrors/gatewaytimeoutresponseerror.mdx | 6 +- docs/models/sdkerrors/goneresponseerror.mdx | 6 +- .../sdkerrors/internalserverresponseerror.mdx | 6 +- .../sdkerrors/internchaterrorresponse.mdx | 2 +- .../models/sdkerrors/internlifecycleerror.mdx | 2 +- .../sdkerrors/notfoundresponseerror.mdx | 6 +- docs/models/sdkerrors/oautherrorresponse.mdx | 4 +- .../payloadtoolargeresponseerror.mdx | 6 +- .../paymentrequiredresponseerror.mdx | 6 +- .../provideroverloadedresponseerror.mdx | 6 +- .../sdkerrors/requesttimeoutresponseerror.mdx | 6 +- .../serviceunavailableresponseerror.mdx | 6 +- .../toomanyrequestsresponseerror.mdx | 6 +- .../sdkerrors/unauthorizedresponseerror.mdx | 6 +- .../unprocessableentityresponseerror.mdx | 6 +- docs/sdks/analytics/README.mdx | 24 +- docs/sdks/apikeys/README.mdx | 42 +-- docs/sdks/batch/README.mdx | 24 +- docs/sdks/benchmarks/README.mdx | 6 +- docs/sdks/betaresponses/README.mdx | 8 +- docs/sdks/byok/README.mdx | 38 +-- docs/sdks/chat/README.mdx | 8 +- docs/sdks/classifications/README.mdx | 6 +- docs/sdks/containers/README.mdx | 34 +- docs/sdks/credits/README.mdx | 4 +- docs/sdks/datasets/README.mdx | 18 +- docs/sdks/decisions/README.mdx | 6 +- docs/sdks/embeddings/README.mdx | 14 +- docs/sdks/endpoints/README.mdx | 12 +- docs/sdks/endusers/README.mdx | 54 ++-- docs/sdks/files/README.mdx | 46 +-- docs/sdks/generations/README.mdx | 18 +- docs/sdks/guardrails/README.mdx | 104 +++---- docs/sdks/images/README.mdx | 18 +- docs/sdks/interns/README.mdx | 106 +++---- docs/sdks/models/README.mdx | 32 +- docs/sdks/oauth/README.mdx | 22 +- docs/sdks/observability/README.mdx | 36 +-- docs/sdks/organization/README.mdx | 18 +- docs/sdks/presets/README.mdx | 56 ++-- docs/sdks/privateendpoints/README.mdx | 68 ++-- docs/sdks/providers/README.mdx | 4 +- docs/sdks/rerank/README.mdx | 6 +- docs/sdks/responses/README.mdx | 8 +- docs/sdks/scim/README.mdx | 58 ++-- docs/sdks/stt/README.mdx | 12 +- docs/sdks/systemone/README.mdx | 6 +- docs/sdks/tools/README.mdx | 20 +- docs/sdks/tts/README.mdx | 6 +- docs/sdks/vault/README.mdx | 68 ++-- docs/sdks/videogeneration/README.mdx | 24 +- docs/sdks/workspaces/README.mdx | 94 +++--- models/components/createenduserrequest.go | 2 +- models/components/enduser.go | 2 +- models/operations/deleteenduser.go | 2 +- models/operations/getenduser.go | 2 +- models/operations/listendusers.go | 2 +- models/operations/updateenduser.go | 2 +- openrouter.go | 4 +- 1270 files changed, 6132 insertions(+), 6122 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 20da57147..17414033b 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,18 +1,18 @@ lockVersion: 2.0.0 id: 9eea3e30-2722-4060-973b-57b7f1f75dc0 management: - docChecksum: dab666f005acdd377e0536c9668eff31 + docChecksum: 69646e97f999247d54e6c12796e404a5 docVersion: 1.0.0 speakeasyVersion: 1.787.0 generationVersion: 2.914.0 - releaseVersion: 0.9.36 - configChecksum: 105580322e969fdcef259c26db15d5de + releaseVersion: 0.9.37 + configChecksum: 9569d21cb93fb8dd9a2510051884350c repoURL: https://github.com/OpenRouterTeam/go-sdk.git installationURL: https://github.com/OpenRouterTeam/go-sdk persistentEdits: - generation_id: 8f04f1ce-0a87-4492-bafb-6f363c73d674 - pristine_commit_hash: 1b5733d0363a27a8e7127553c9b811715f96ed9f - pristine_tree_hash: 465636b1578ecf3f4394b841bb3136fbe0dd7b86 + generation_id: 866bbcee-3b7a-4172-976b-277e9f868c70 + pristine_commit_hash: 13ddd8be5ded3b2087dbeaa380896db2f17578d9 + pristine_tree_hash: 698f8bf6be61b767dd6c51e98266c1f4881bfc6e features: go: acceptHeaders: 2.81.2 @@ -2561,8 +2561,8 @@ trackedFiles: pristine_git_object: c0e18d9d9ad5e7a126ac76eaecaaa8fd72227dd2 docs/models/components/createenduserrequest.mdx: id: 79211a301334 - last_write_checksum: sha1:85dea58eb1860ea593290397bcaf2339b3093b7d - pristine_git_object: 0f24ee2a39a05b2e4f59b9a076e244455e81c15e + last_write_checksum: sha1:3e554b1670c474ca1e41bd35427172420f11eb45 + pristine_git_object: 695800505a097a86cafe1ba60fd6faae6c19b861 docs/models/components/createguardrailrequest.mdx: id: f2be013836bb last_write_checksum: sha1:940b8fdbb018c76852fccc705a0eba1a2f0d0c20 @@ -2985,8 +2985,8 @@ trackedFiles: pristine_git_object: 8f3b7088427adef28edae260742392e9c2954b4f docs/models/components/enduser.mdx: id: 84d986274ef3 - last_write_checksum: sha1:6d21cadd2b576c9b9fb3f75da05220280cf9c9fe - pristine_git_object: 4c9f3b9d7eb595e3be34060f4fc7381bef0ff94d + last_write_checksum: sha1:9d2866a9f8c010abbeb5899cec5dc0d8c572b8cc + pristine_git_object: 9dfecf17bf2f346347555b6b8fd6883614559244 docs/models/components/enduserresponse.mdx: id: 175b9548e443 last_write_checksum: sha1:5c059910e0af7ecb5a7bcc42ac628169d1bef12c @@ -8221,8 +8221,8 @@ trackedFiles: pristine_git_object: d5e78b429aba6a73ff48891c65cdb3ca254d05bb docs/models/operations/deleteenduserrequest.mdx: id: c777a49bbbaa - last_write_checksum: sha1:30f60ccb511063190f1c71c55f6e38f466d718aa - pristine_git_object: 5e8156af154d2750f551129cd6cd411b77a36ed1 + last_write_checksum: sha1:472aa14756be33d38ddde916596c0468cd4d1438 + pristine_git_object: 94e9f4d329958b666cd4e19de1f8d206af9da8f3 docs/models/operations/deletefilerequest.mdx: id: 09572e0d323d last_write_checksum: sha1:e9a314cccf32cb2227c62abae2373732c160853d @@ -8405,8 +8405,8 @@ trackedFiles: pristine_git_object: 0631c3dfe6c142199beb9469be398a6e324641c0 docs/models/operations/getenduserrequest.mdx: id: 57b6e423c523 - last_write_checksum: sha1:21bf000d635d5aa325fcbd23bceab7e457192965 - pristine_git_object: 2e1880834d64631d4a2b03becee06e35a163d8cd + last_write_checksum: sha1:929a8b802cb4fdb44aeb36fa8f24928a31994a24 + pristine_git_object: 432f641e01578a61ec34ce1877c0540d7dbd747c docs/models/operations/getfilemetadatarequest.mdx: id: c0c091f58c77 last_write_checksum: sha1:2de0af90e08b149464ab09738bd4d9dd34ee2de0 @@ -8633,8 +8633,8 @@ trackedFiles: pristine_git_object: 3aed99b5d423057ffda86f513517ca99fb7ede7b docs/models/operations/listendusersrequest.mdx: id: 980cdfd14268 - last_write_checksum: sha1:6cd4fe62fa8ca69bbb838f3212a2e707337a6da5 - pristine_git_object: 96f2ee6d4b5233ac57e1cc2be9a96a4fc41d2313 + last_write_checksum: sha1:22b81b6a66e57181ebacc0db95972b0ade06300b + pristine_git_object: 7ea3dac06ed0703aef733858247d116e41b4a8e7 docs/models/operations/listendusersresponse.mdx: id: 24039ce40e13 last_write_checksum: sha1:ca7b31170865bee37067cd59ac791e0e007e1826 @@ -9009,8 +9009,8 @@ trackedFiles: pristine_git_object: bc1e0e9cf0fcbc821d7c6013d721dc927726248a docs/models/operations/updateenduserrequest.mdx: id: 60ceef4bf4f8 - last_write_checksum: sha1:8e73321af1b2fd7cce0b3927b3e0a31d346f5139 - pristine_git_object: ca77914c9371ae9632abc8d55959d5c0bc367af5 + last_write_checksum: sha1:68c3bc3587de0c20d04100e2559e2ab231346b48 + pristine_git_object: 08747ded8a057e6846cd8ad7d6065a036ddce49a docs/models/operations/updateguardrailrequest.mdx: id: 28e8a7d06289 last_write_checksum: sha1:951286e0038b229a04d843c99a4f83fb449dd5e6 @@ -9281,8 +9281,8 @@ trackedFiles: pristine_git_object: 844044ad6d1c3d29314dee5b5accfac86245ff19 docs/sdks/endusers/README.mdx: id: ba369f05185b - last_write_checksum: sha1:0ace6f60ed40e1b60cbdaa21fa35fc53db7d665f - pristine_git_object: 3f507fe47595d2fdc2ee84c844f01da8a907b32c + last_write_checksum: sha1:ef69ac199361c7afbb6ffaa44328ffd80077c16c + pristine_git_object: 32c4de712e62b00454d1308efe57cef95fdd48b7 docs/sdks/files/README.mdx: id: 1a0c257e330c last_write_checksum: sha1:b8a41f46bfc02e1a1b0a560181a6d38fa857ab03 @@ -10533,8 +10533,8 @@ trackedFiles: pristine_git_object: c3d386cf733dce28e6f608f75152854d71d909a6 models/components/createenduserrequest.go: id: 7ac591fc6b8e - last_write_checksum: sha1:4d5397e8346705cd54ad80b218f23483bf2ceb51 - pristine_git_object: b2acc22824298706fca76416954d38072525fc29 + last_write_checksum: sha1:45028c71595002d55b7e44669ae9bfa858104b23 + pristine_git_object: 196bd3776d4bb90eb951d2ae2bd5e8a795e060c3 models/components/createguardrailrequest.go: id: a62ed1a0ae01 last_write_checksum: sha1:a58658e8bac02da047b64260c7cdf39840830aee @@ -10717,8 +10717,8 @@ trackedFiles: pristine_git_object: 2726eccc5ad1134c26800006a83ed50edbbcb2fd models/components/enduser.go: id: 05ec59c39adf - last_write_checksum: sha1:3f0999a598959a43d4796c9196f7afc6e4cf2e6c - pristine_git_object: 29686a12aaad2aef5a973fd290cb0d9add956108 + last_write_checksum: sha1:4e4c2442819c2e8f2111ba74dd07468efffb3b03 + pristine_git_object: 74b83e87a897dbf30b1c532eb013e4bb580a9676 models/components/enduserresponse.go: id: 972ef0b0955d last_write_checksum: sha1:e48d7fa5c95f9e32d36879a6f5189c855e145b51 @@ -12965,8 +12965,8 @@ trackedFiles: pristine_git_object: b8d0012e682c294b06a771d03e2386a1df30d46e models/operations/deleteenduser.go: id: 253b1f2f787a - last_write_checksum: sha1:9befb46561018c13532abcc04b77a57e4c2a151c - pristine_git_object: 6c9c95408c21bb7e110fc61a5da782fed7b12676 + last_write_checksum: sha1:30dfbae0dc3f05e24230a28ffed31be51047c380 + pristine_git_object: e50348f29096926398ea8581a8d74d2f6585f83e models/operations/deletefile.go: id: 15ca30b82fbf last_write_checksum: sha1:4c4fe0019cc9b2edd954f09d30d43ba11aa4d017 @@ -13065,8 +13065,8 @@ trackedFiles: pristine_git_object: 4517257a84c56b7d934cc537ddd77d7ae6701a39 models/operations/getenduser.go: id: 810e45071c26 - last_write_checksum: sha1:76249bc1cc117b708cafaee81755a339208275e1 - pristine_git_object: 0caffce69065c0353fcf8a533a1be155f2fc9f4c + last_write_checksum: sha1:16c10e54b3589cfba129964be525bf46c2c4be82 + pristine_git_object: 748955cbdb2f2ddd140359de27878e758d2a6140 models/operations/getfilemetadata.go: id: ac54c1bc940b last_write_checksum: sha1:89aeac7e3a0eae9a1d74c73c7edc25a5378de1b2 @@ -13197,8 +13197,8 @@ trackedFiles: pristine_git_object: de2caab374aa9b4b1e8378584e425e4f3a6b252e models/operations/listendusers.go: id: 82d629f0091a - last_write_checksum: sha1:3f1c408f7b6b50eb6047f3a2ef313a006c355356 - pristine_git_object: e2bcd200f5b0d1114bd893dd56e93a4a03af48ef + last_write_checksum: sha1:93e5d6460e0c0164a8a1ffea2a7adea74b5d4e96 + pristine_git_object: 2b552c4ca40ce63f0ee382669fc0144bc07d7af5 models/operations/listfiles.go: id: dc325e3fde5f last_write_checksum: sha1:353dbb43dc818ecc846c3e4696c83cab1d4a1c7d @@ -13349,8 +13349,8 @@ trackedFiles: pristine_git_object: f5af8797b9e96618655d8e4a59bcc96d00204f2f models/operations/updateenduser.go: id: 9ef6508f1321 - last_write_checksum: sha1:3e638967b270cfe9a9ae24e94f13bff46eeb1acf - pristine_git_object: 0c34e0c67f60599387d0a2c6d65a67e9dae2980f + last_write_checksum: sha1:caaa57303f14ed5b56b1e8c29c54ffe2f1eb32b8 + pristine_git_object: c337b45404ece81853b0c8c0793c32e8871b6119 models/operations/updateguardrail.go: id: 91384d66e9d9 last_write_checksum: sha1:4fa2ac4f720341443020c99695abecbbd9367cf3 @@ -13509,8 +13509,8 @@ trackedFiles: pristine_git_object: 5e3a2cdf8cb4ed4f5378b712293cba9c82074f16 openrouter.go: id: 207ad004b774 - last_write_checksum: sha1:600da98bc806c1378a531d03e8eaabba0296db1b - pristine_git_object: bfc05ca81fecfe28c7dff49e61d25d494366d664 + last_write_checksum: sha1:c5d68fe900e5b30fe93ee26a24fabfe32d12b1fe + pristine_git_object: 94e6e806d8d133dc16d488d902c416c5951a71fc optionalnullable/optionalnullable.go: id: ce60f259ead3 last_write_checksum: sha1:d6aff1a420c31e025ea21d46cf056e305ae76fe8 diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 19cf83e13..3af0ab1bd 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -36,7 +36,7 @@ generation: documentation: mintlify preApplyUnionDiscriminators: true go: - version: 0.9.36 + version: 0.9.37 additionalDependencies: {} baseErrorName: OpenRouterError clientServerStatusCodesAsErrors: true diff --git a/.speakeasy/out.openapi.yaml b/.speakeasy/out.openapi.yaml index 32a9d470e..db5cfbf9b 100644 --- a/.speakeasy/out.openapi.yaml +++ b/.speakeasy/out.openapi.yaml @@ -9395,11 +9395,11 @@ components: user: 'employee_123' properties: user: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' example: 'employee_123' - maxLength: 256 + maxLength: 512 minLength: 1 - pattern: '^[^\p{Cc}]+$' + pattern: '^[^\u0000]+$' type: 'string' required: - 'user' @@ -10908,11 +10908,11 @@ components: format: 'date-time' type: 'string' user: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' example: 'employee_123' - maxLength: 256 + maxLength: 512 minLength: 1 - pattern: '^[^\p{Cc}]+$' + pattern: '^[^\u0000]+$' type: 'string' required: - 'user' @@ -38142,16 +38142,16 @@ paths: maximum: 100 minimum: 1 type: 'integer' - - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + - description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' in: 'query' name: 'user' required: false schema: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' example: 'employee_123' - maxLength: 256 + maxLength: 512 minLength: 1 - pattern: '^[^\p{Cc}]+$' + pattern: '^[^\u0000]+$' type: 'string' - description: 'Include deactivated registrations.' in: 'query' @@ -38314,16 +38314,16 @@ paths: description: 'Soft-deactivate a registration while retaining its tracking ID. Repeat deactivation succeeds. This does not block inference; reactivate through PATCH. [Management key](/docs/guides/overview/auth/management-api-keys) required.' operationId: 'deleteEndUser' parameters: - - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + - description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' in: 'path' name: 'user' required: true schema: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' example: 'employee_123' - maxLength: 256 + maxLength: 512 minLength: 1 - pattern: '^[^\p{Cc}]+$' + pattern: '^[^\u0000]+$' type: 'string' responses: '204': @@ -38376,16 +38376,16 @@ paths: description: 'Retrieve an active or inactive registration by its URL-encoded, caller-supplied tracking ID. [Management key](/docs/guides/overview/auth/management-api-keys) required.' operationId: 'getEndUser' parameters: - - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + - description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' in: 'path' name: 'user' required: true schema: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' example: 'employee_123' - maxLength: 256 + maxLength: 512 minLength: 1 - pattern: '^[^\p{Cc}]+$' + pattern: '^[^\u0000]+$' type: 'string' responses: '200': @@ -38448,16 +38448,16 @@ paths: description: 'Update registration state without changing identity. State changes do not enforce inference access. [Management key](/docs/guides/overview/auth/management-api-keys) required.' operationId: 'updateEndUser' parameters: - - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + - description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' in: 'path' name: 'user' required: true schema: - description: 'Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths.' + description: 'Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter.' example: 'employee_123' - maxLength: 256 + maxLength: 512 minLength: 1 - pattern: '^[^\p{Cc}]+$' + pattern: '^[^\u0000]+$' type: 'string' requestBody: content: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index cc23e3c4f..aeafde53e 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,8 +2,8 @@ speakeasyVersion: 1.787.0 sources: OpenRouter API: sourceNamespace: open-router-chat-completions-api - sourceRevisionDigest: sha256:31c1bc0f901feeb5ed0f1957a7185759d8231786bcc65e8067e29cdf499a0312 - sourceBlobDigest: sha256:82768586b9b7629e6631fa3e625472af66a172b8c6d56fb41c370c4b36ba1e07 + sourceRevisionDigest: sha256:538d25690f9e14868bfece446f5b52f484f02be90bab4251c891a4527a405217 + sourceBlobDigest: sha256:76b05683f56c51a0888239e27ea31d6aafca3a8cb980374629ffcae932aff2f1 tags: - latest - 1.0.0 @@ -11,10 +11,10 @@ targets: openrouter: source: OpenRouter API sourceNamespace: open-router-chat-completions-api - sourceRevisionDigest: sha256:31c1bc0f901feeb5ed0f1957a7185759d8231786bcc65e8067e29cdf499a0312 - sourceBlobDigest: sha256:82768586b9b7629e6631fa3e625472af66a172b8c6d56fb41c370c4b36ba1e07 + sourceRevisionDigest: sha256:538d25690f9e14868bfece446f5b52f484f02be90bab4251c891a4527a405217 + sourceBlobDigest: sha256:76b05683f56c51a0888239e27ea31d6aafca3a8cb980374629ffcae932aff2f1 codeSamplesNamespace: open-router-chat-completions-api-go-code-samples - codeSamplesRevisionDigest: sha256:3b80d526778aa46a50a38ead0de0f0c532c44a66a416f60306437d15d6470015 + codeSamplesRevisionDigest: sha256:da29459564570ca8ba06479d5c692b7a3f7c50926077a7a02f1487949359cf25 workflow: workflowVersion: 1.0.0 speakeasyVersion: 1.787.0 diff --git a/RELEASES.md b/RELEASES.md index a55d0f0d2..40fc1b170 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -2878,4 +2878,14 @@ Based on: ### Generated - [go v0.9.36] . ### Releases -- [Go v0.9.36] https://github.com/OpenRouterTeam/go-sdk/releases/tag/v0.9.36 - . \ No newline at end of file +- [Go v0.9.36] https://github.com/OpenRouterTeam/go-sdk/releases/tag/v0.9.36 - . + +## 2026-10-09 00:13:39 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.787.0 (2.914.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [go v0.9.37] . +### Releases +- [Go v0.9.37] https://github.com/OpenRouterTeam/go-sdk/releases/tag/v0.9.37 - . \ No newline at end of file diff --git a/docs/models/components/aabenchmarkentry.mdx b/docs/models/components/aabenchmarkentry.mdx index db2276972..e22b143cf 100644 --- a/docs/models/components/aabenchmarkentry.mdx +++ b/docs/models/components/aabenchmarkentry.mdx @@ -9,6 +9,6 @@ Artificial Analysis benchmark index scores. | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `AgenticIndex` | `*float64` | ✅ | Artificial Analysis Agentic Index score | 55.8 | -| `CodingIndex` | `*float64` | ✅ | Artificial Analysis Coding Index score | 63.2 | -| `IntelligenceIndex` | `*float64` | ✅ | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file +| `AgenticIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 | +| `CodingIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 | +| `IntelligenceIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file diff --git a/docs/models/components/activityitem.mdx b/docs/models/components/activityitem.mdx index a661a114a..2207b59ba 100644 --- a/docs/models/components/activityitem.mdx +++ b/docs/models/components/activityitem.mdx @@ -6,16 +6,16 @@ title: "ActivityItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsageInference` | `float64` | ✅ | BYOK inference cost in USD (external credits spent) | 0.012 | -| `CachedTokens` | `int64` | ✅ | Total prompt tokens read from the provider prompt cache (cache hits). Generally a subset of `prompt_tokens`; for replayed response-cache hits the provider may report the two counters over disjoint token sets, so `cached_tokens` can exceed `prompt_tokens`. | 10 | -| `CompletionTokens` | `int64` | ✅ | Total completion tokens generated | 125 | -| `Date` | `string` | ✅ | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `EndpointID` | `string` | ✅ | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `Model` | `string` | ✅ | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `ModelPermaslug` | `string` | ✅ | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `PromptTokens` | `int64` | ✅ | Total prompt tokens used | 50 | -| `ProviderName` | `string` | ✅ | Name of the provider serving this endpoint | OpenAI | -| `ReasoningTokens` | `int64` | ✅ | Total reasoning tokens used | 25 | -| `Requests` | `int64` | ✅ | Number of requests made | 5 | -| `Usage` | `float64` | ✅ | Total cost in USD (OpenRouter credits spent) | 0.015 | -| `WorkspaceID` | `*string` | ➖ | ID of the workspace this activity is attributed to. Only present when `group_by=workspace` is passed; the response is then split per workspace. Activity recorded before workspace resolution existed is attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `BYOKUsageInference` | `float64` | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | +| `CachedTokens` | `int64` | :heavy_check_mark: | Total prompt tokens read from the provider prompt cache (cache hits). Generally a subset of `prompt_tokens`; for replayed response-cache hits the provider may report the two counters over disjoint token sets, so `cached_tokens` can exceed `prompt_tokens`. | 10 | +| `CompletionTokens` | `int64` | :heavy_check_mark: | Total completion tokens generated | 125 | +| `Date` | `string` | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | +| `EndpointID` | `string` | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | +| `Model` | `string` | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | +| `PromptTokens` | `int64` | :heavy_check_mark: | Total prompt tokens used | 50 | +| `ProviderName` | `string` | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | +| `ReasoningTokens` | `int64` | :heavy_check_mark: | Total reasoning tokens used | 25 | +| `Requests` | `int64` | :heavy_check_mark: | Number of requests made | 5 | +| `Usage` | `float64` | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | ID of the workspace this activity is attributed to. Only present when `group_by=workspace` is passed; the response is then split per workspace. Activity recorded before workspace resolution existed is attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/activityresponse.mdx b/docs/models/components/activityresponse.mdx index 541d5f7d7..4fd6bd116 100644 --- a/docs/models/components/activityresponse.mdx +++ b/docs/models/components/activityresponse.mdx @@ -6,4 +6,4 @@ title: "ActivityResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Data` | [][components.ActivityItem](../../models/components/activityitem.mdx) | ✅ | List of activity items | \ No newline at end of file +| `Data` | [][components.ActivityItem](../../models/components/activityitem.mdx) | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/docs/models/components/additionaltoolsitem.mdx b/docs/models/components/additionaltoolsitem.mdx index 3ff9dffec..3c00f4bd5 100644 --- a/docs/models/components/additionaltoolsitem.mdx +++ b/docs/models/components/additionaltoolsitem.mdx @@ -9,7 +9,7 @@ Additional tools made available to the model at this point in the input | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Role` | [components.AdditionalToolsItemRole](../../models/components/additionaltoolsitemrole.mdx) | ✅ | N/A | -| `Tools` | [][components.AdditionalToolsItemToolUnion](../../models/components/additionaltoolsitemtoolunion.mdx) | ✅ | N/A | -| `Type` | [components.TypeAdditionalTools](../../models/components/typeadditionaltools.mdx) | ✅ | N/A | \ No newline at end of file +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Role` | [components.AdditionalToolsItemRole](../../models/components/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A | +| `Tools` | [][components.AdditionalToolsItemToolUnion](../../models/components/additionaltoolsitemtoolunion.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeAdditionalTools](../../models/components/typeadditionaltools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/additionaltoolsitemtool.mdx b/docs/models/components/additionaltoolsitemtool.mdx index dee019313..aac7add44 100644 --- a/docs/models/components/additionaltoolsitemtool.mdx +++ b/docs/models/components/additionaltoolsitemtool.mdx @@ -6,5 +6,5 @@ title: "AdditionalToolsItemTool" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Type` | `string` | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/additionaltoolsitemtoolfunction.mdx b/docs/models/components/additionaltoolsitemtoolfunction.mdx index 3cd4e1b74..74e3f14e6 100644 --- a/docs/models/components/additionaltoolsitemtoolfunction.mdx +++ b/docs/models/components/additionaltoolsitemtoolfunction.mdx @@ -9,10 +9,10 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Parameters` | map[string]`any` | ✅ | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `Type` | [components.AdditionalToolsItemTypeFunction](../../models/components/additionaltoolsitemtypefunction.mdx) | ✅ | N/A | | -| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.AdditionalToolsItemTypeFunction](../../models/components/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A | | +| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/components/advisorreasoning.mdx b/docs/models/components/advisorreasoning.mdx index f6c42539f..e1eb8f5f7 100644 --- a/docs/models/components/advisorreasoning.mdx +++ b/docs/models/components/advisorreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the advisor call. Use this to control reaso | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `Effort` | [*components.AdvisorReasoningEffort](../../models/components/advisorreasoningeffort.mdx) | ➖ | Reasoning effort level for the advisor call. | -| `MaxTokens` | `*int64` | ➖ | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file +| `Effort` | [*components.AdvisorReasoningEffort](../../models/components/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | +| `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file diff --git a/docs/models/components/advisorservertoolconfig.mdx b/docs/models/components/advisorservertoolconfig.mdx index c1168ce9e..6a2c62132 100644 --- a/docs/models/components/advisorservertoolconfig.mdx +++ b/docs/models/components/advisorservertoolconfig.mdx @@ -9,11 +9,11 @@ Configuration for one openrouter:advisor server tool entry. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ForwardTranscript` | `*bool` | ➖ | When true, the full parent conversation is forwarded to the advisor so it sees the same context the executor does (and the tool-call `prompt`, if given, is appended as a final user turn). When false or omitted, the advisor receives only the `prompt` the executor passes in the tool call. | false | -| `Instructions` | `*string` | ➖ | System instructions for the advisor sub-agent. When omitted, the advisor responds with no system prompt of its own. | You are a senior staff engineer. Give a focused, decisive plan. | -| `MaxCompletionTokens` | `*int64` | ➖ | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | -| `Model` | `*string` | ➖ | Slug of the advisor model to consult (any OpenRouter model). When omitted, the executor can choose it via the tool call's `model` argument; if neither is set, the model from the outer API request is used. | ~anthropic/claude-opus-latest | -| `Name` | `*string` | ➖ | Optional name for this advisor. The model sees one tool per named advisor (and one default for an unnamed entry). Names must be unique across advisor entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | reviewer | -| `Reasoning` | [*components.AdvisorReasoning](../../models/components/advisorreasoning.mdx) | ➖ | Reasoning configuration forwarded to the advisor call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "high"
} | -| `Stream` | `*bool` | ➖ | When true, the advisor's advice streams incrementally as it is produced. In the Responses API this emits `response.output_text.delta` events targeting the advisor output item; the final `advice` field is still set on the completed item. Has no effect on the Chat Completions API (where the advice arrives only as the final tool result). When false or omitted, the advice arrives only as the final result. | false | -| `Temperature` | `*float64` | ➖ | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file +| `ForwardTranscript` | `*bool` | :heavy_minus_sign: | When true, the full parent conversation is forwarded to the advisor so it sees the same context the executor does (and the tool-call `prompt`, if given, is appended as a final user turn). When false or omitted, the advisor receives only the `prompt` the executor passes in the tool call. | false | +| `Instructions` | `*string` | :heavy_minus_sign: | System instructions for the advisor sub-agent. When omitted, the advisor responds with no system prompt of its own. | You are a senior staff engineer. Give a focused, decisive plan. | +| `MaxCompletionTokens` | `*int64` | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | +| `Model` | `*string` | :heavy_minus_sign: | Slug of the advisor model to consult (any OpenRouter model). When omitted, the executor can choose it via the tool call's `model` argument; if neither is set, the model from the outer API request is used. | ~anthropic/claude-opus-latest | +| `Name` | `*string` | :heavy_minus_sign: | Optional name for this advisor. The model sees one tool per named advisor (and one default for an unnamed entry). Names must be unique across advisor entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | reviewer | +| `Reasoning` | [*components.AdvisorReasoning](../../models/components/advisorreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to the advisor call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "high"
} | +| `Stream` | `*bool` | :heavy_minus_sign: | When true, the advisor's advice streams incrementally as it is produced. In the Responses API this emits `response.output_text.delta` events targeting the advisor output item; the final `advice` field is still set on the completed item. Has no effect on the Chat Completions API (where the advice arrives only as the final tool result). When false or omitted, the advice arrives only as the final result. | false | +| `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file diff --git a/docs/models/components/advisorservertoolopenrouter.mdx b/docs/models/components/advisorservertoolopenrouter.mdx index 6ca538efa..7d498b118 100644 --- a/docs/models/components/advisorservertoolopenrouter.mdx +++ b/docs/models/components/advisorservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: consults a higher-intelligence advisor model (a | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.AdvisorServerToolConfig](../../models/components/advisorservertoolconfig.mdx) | ➖ | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | -| `Type` | [components.AdvisorServerToolOpenRouterType](../../models/components/advisorservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.AdvisorServerToolConfig](../../models/components/advisorservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | +| `Type` | [components.AdvisorServerToolOpenRouterType](../../models/components/advisorservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/agent.mdx b/docs/models/components/agent.mdx index f449b49ca..6b4b43330 100644 --- a/docs/models/components/agent.mdx +++ b/docs/models/components/agent.mdx @@ -6,5 +6,5 @@ title: "Agent" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `AgentName` | `string` | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `AgentName` | `string` | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/agentmessageitem.mdx b/docs/models/components/agentmessageitem.mdx index 1bb5cfa4b..a11f51898 100644 --- a/docs/models/components/agentmessageitem.mdx +++ b/docs/models/components/agentmessageitem.mdx @@ -9,10 +9,10 @@ A message routed between agents in a multi-agent session | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `Agent` | optionalnullable.OptionalNullable[[components.Agent](../../models/components/agent.mdx)] | ➖ | N/A | | -| `Author` | `string` | ✅ | N/A | | -| `Content` | [][components.AgentMessageItemContentUnion](../../models/components/agentmessageitemcontentunion.mdx) | ✅ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Recipient` | `string` | ✅ | N/A | | -| `Type` | [components.TypeAgentMessage](../../models/components/typeagentmessage.mdx) | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"author": "/root/worker",
"content": [
\{
"text": "Task complete.",
"type": "input_text"
}
],
"recipient": "/root",
"type": "agent_message"
} | \ No newline at end of file +| `Agent` | optionalnullable.OptionalNullable[[components.Agent](../../models/components/agent.mdx)] | :heavy_minus_sign: | N/A | | +| `Author` | `string` | :heavy_check_mark: | N/A | | +| `Content` | [][components.AgentMessageItemContentUnion](../../models/components/agentmessageitemcontentunion.mdx) | :heavy_check_mark: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Recipient` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeAgentMessage](../../models/components/typeagentmessage.mdx) | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"author": "/root/worker",
"content": [
\{
"text": "Task complete.",
"type": "input_text"
}
],
"recipient": "/root",
"type": "agent_message"
} | \ No newline at end of file diff --git a/docs/models/components/agentmessageitemcontentinputimage.mdx b/docs/models/components/agentmessageitemcontentinputimage.mdx index 34d75d235..d42349fe7 100644 --- a/docs/models/components/agentmessageitemcontentinputimage.mdx +++ b/docs/models/components/agentmessageitemcontentinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.AgentMessageItemDetail](../../models/components/agentmessageitemdetail.mdx) | ✅ | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.AgentMessageItemTypeInputImage](../../models/components/agentmessageitemtypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file +| `Detail` | [components.AgentMessageItemDetail](../../models/components/agentmessageitemdetail.mdx) | :heavy_check_mark: | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.AgentMessageItemTypeInputImage](../../models/components/agentmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/alignment.mdx b/docs/models/components/alignment.mdx index e05c5d9c5..3dd1f5b58 100644 --- a/docs/models/components/alignment.mdx +++ b/docs/models/components/alignment.mdx @@ -9,4 +9,4 @@ Beta. The result of the alignment plugin for this request; the shape may change. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Calls` | [][components.AlignmentCallRecord](../../models/components/alignmentcallrecord.mdx) | ✅ | One record per evaluated assistant message of the request, in the order the messages were produced. | \ No newline at end of file +| `Calls` | [][components.AlignmentCallRecord](../../models/components/alignmentcallrecord.mdx) | :heavy_check_mark: | One record per evaluated assistant message of the request, in the order the messages were produced. | \ No newline at end of file diff --git a/docs/models/components/alignmentallowedcallrecord.mdx b/docs/models/components/alignmentallowedcallrecord.mdx index 85b7b6977..c53c0c1fc 100644 --- a/docs/models/components/alignmentallowedcallrecord.mdx +++ b/docs/models/components/alignmentallowedcallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentAllowedCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Call` | `int64` | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `Outcome` | [components.AlignmentAllowedCallRecordOutcome](../../models/components/alignmentallowedcallrecordoutcome.mdx) | ✅ | N/A | -| `Rules` | [][components.AlignmentRuleRecord](../../models/components/alignmentrulerecord.mdx) | ✅ | One record per rule, in the order of `rules` in the request. | \ No newline at end of file +| `Call` | `int64` | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `Outcome` | [components.AlignmentAllowedCallRecordOutcome](../../models/components/alignmentallowedcallrecordoutcome.mdx) | :heavy_check_mark: | N/A | +| `Rules` | [][components.AlignmentRuleRecord](../../models/components/alignmentrulerecord.mdx) | :heavy_check_mark: | One record per rule, in the order of `rules` in the request. | \ No newline at end of file diff --git a/docs/models/components/alignmentblockedcallrecord.mdx b/docs/models/components/alignmentblockedcallrecord.mdx index c03d0c1d4..699c22f59 100644 --- a/docs/models/components/alignmentblockedcallrecord.mdx +++ b/docs/models/components/alignmentblockedcallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentBlockedCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Call` | `int64` | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `Outcome` | [components.AlignmentBlockedCallRecordOutcome](../../models/components/alignmentblockedcallrecordoutcome.mdx) | ✅ | N/A | -| `Rules` | [][components.AlignmentRuleRecord](../../models/components/alignmentrulerecord.mdx) | ✅ | One record per rule, in the order of `rules` in the request. | \ No newline at end of file +| `Call` | `int64` | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `Outcome` | [components.AlignmentBlockedCallRecordOutcome](../../models/components/alignmentblockedcallrecordoutcome.mdx) | :heavy_check_mark: | N/A | +| `Rules` | [][components.AlignmentRuleRecord](../../models/components/alignmentrulerecord.mdx) | :heavy_check_mark: | One record per rule, in the order of `rules` in the request. | \ No newline at end of file diff --git a/docs/models/components/alignmentchataudio.mdx b/docs/models/components/alignmentchataudio.mdx index 9d4d73d3e..610df35df 100644 --- a/docs/models/components/alignmentchataudio.mdx +++ b/docs/models/components/alignmentchataudio.mdx @@ -9,5 +9,5 @@ The audio of the withheld message: its `id` and `transcript`. The plugin does no | Field | Type | Required | Description | | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `ID` | `*string` | ➖ | The provider id of the audio. | -| `Transcript` | `string` | ✅ | The transcript of the audio. | \ No newline at end of file +| `ID` | `*string` | :heavy_minus_sign: | The provider id of the audio. | +| `Transcript` | `string` | :heavy_check_mark: | The transcript of the audio. | \ No newline at end of file diff --git a/docs/models/components/alignmentchatimage.mdx b/docs/models/components/alignmentchatimage.mdx index 61192c4a7..7db4664c9 100644 --- a/docs/models/components/alignmentchatimage.mdx +++ b/docs/models/components/alignmentchatimage.mdx @@ -6,5 +6,5 @@ title: "AlignmentChatImage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ImageURL` | [components.AlignmentChatImageImageURL](../../models/components/alignmentchatimageimageurl.mdx) | ✅ | N/A | -| `Type` | [components.AlignmentChatImageType](../../models/components/alignmentchatimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `ImageURL` | [components.AlignmentChatImageImageURL](../../models/components/alignmentchatimageimageurl.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AlignmentChatImageType](../../models/components/alignmentchatimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/alignmentchatimageimageurl.mdx b/docs/models/components/alignmentchatimageimageurl.mdx index f3458b63d..fb39cc71c 100644 --- a/docs/models/components/alignmentchatimageimageurl.mdx +++ b/docs/models/components/alignmentchatimageimageurl.mdx @@ -6,4 +6,4 @@ title: "AlignmentChatImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/alignmentchatrejected.mdx b/docs/models/components/alignmentchatrejected.mdx index ed8ad7b2a..515f2d0a5 100644 --- a/docs/models/components/alignmentchatrejected.mdx +++ b/docs/models/components/alignmentchatrejected.mdx @@ -9,9 +9,9 @@ The assistant message of the withheld turn, without reasoning. `audio` holds the | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Audio` | [*components.AlignmentChatAudio](../../models/components/alignmentchataudio.mdx) | ➖ | The audio of the withheld message: its `id` and `transcript`. The plugin does not retain `data` or `expires_at`. | \{
"id": "audio_abc123",
"transcript": "Sure, I can take 20% off your order."
} | -| `Content` | `*string` | ✅ | N/A | | -| `Images` | [][components.AlignmentChatImage](../../models/components/alignmentchatimage.mdx) | ➖ | N/A | | -| `Refusal` | `*string` | ✅ | N/A | | -| `Role` | [components.AlignmentChatRejectedRole](../../models/components/alignmentchatrejectedrole.mdx) | ✅ | N/A | | -| `ToolCalls` | [][components.AlignmentChatToolCall](../../models/components/alignmentchattoolcall.mdx) | ➖ | N/A | | \ No newline at end of file +| `Audio` | [*components.AlignmentChatAudio](../../models/components/alignmentchataudio.mdx) | :heavy_minus_sign: | The audio of the withheld message: its `id` and `transcript`. The plugin does not retain `data` or `expires_at`. | \{
"id": "audio_abc123",
"transcript": "Sure, I can take 20% off your order."
} | +| `Content` | `*string` | :heavy_check_mark: | N/A | | +| `Images` | [][components.AlignmentChatImage](../../models/components/alignmentchatimage.mdx) | :heavy_minus_sign: | N/A | | +| `Refusal` | `*string` | :heavy_check_mark: | N/A | | +| `Role` | [components.AlignmentChatRejectedRole](../../models/components/alignmentchatrejectedrole.mdx) | :heavy_check_mark: | N/A | | +| `ToolCalls` | [][components.AlignmentChatToolCall](../../models/components/alignmentchattoolcall.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/alignmentchattoolcall.mdx b/docs/models/components/alignmentchattoolcall.mdx index 347bb0223..878956fe6 100644 --- a/docs/models/components/alignmentchattoolcall.mdx +++ b/docs/models/components/alignmentchattoolcall.mdx @@ -6,6 +6,6 @@ title: "AlignmentChatToolCall" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Function` | [components.AlignmentChatToolCallFunction](../../models/components/alignmentchattoolcallfunction.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Type` | [components.AlignmentChatToolCallType](../../models/components/alignmentchattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file +| `Function` | [components.AlignmentChatToolCallFunction](../../models/components/alignmentchattoolcallfunction.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AlignmentChatToolCallType](../../models/components/alignmentchattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/alignmentchattoolcallfunction.mdx b/docs/models/components/alignmentchattoolcallfunction.mdx index 5d128bbf9..937003467 100644 --- a/docs/models/components/alignmentchattoolcallfunction.mdx +++ b/docs/models/components/alignmentchattoolcallfunction.mdx @@ -6,5 +6,5 @@ title: "AlignmentChatToolCallFunction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Arguments` | `string` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/alignmentplugin.mdx b/docs/models/components/alignmentplugin.mdx index 965076e56..27910344e 100644 --- a/docs/models/components/alignmentplugin.mdx +++ b/docs/models/components/alignmentplugin.mdx @@ -9,9 +9,9 @@ Beta. States the listed rules to the model and evaluates every turn against them | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | [components.AlignmentPluginID](../../models/components/alignmentpluginid.mdx) | ✅ | N/A | | -| `Instruct` | `*bool` | ➖ | Whether the rules are stated to the model in a system message on every provider call. Default true. | | -| `MaxRetries` | `*int64` | ➖ | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | -| `Mode` | [*components.AlignmentPluginMode](../../models/components/alignmentpluginmode.mdx) | ➖ | `enforce`: a turn that breaks a rule is withheld, retried, and finally returned as an error. `audit`: every turn is evaluated and returned. Default `enforce`. | | -| `Rules` | []`string` | ✅ | Texts that state what the reply must do or must not do. Each rule is evaluated on its own. | [
"Never offer a discount.",
"End with exactly one question."
] | -| `Threshold` | `*float64` | ➖ | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file +| `ID` | [components.AlignmentPluginID](../../models/components/alignmentpluginid.mdx) | :heavy_check_mark: | N/A | | +| `Instruct` | `*bool` | :heavy_minus_sign: | Whether the rules are stated to the model in a system message on every provider call. Default true. | | +| `MaxRetries` | `*int64` | :heavy_minus_sign: | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | +| `Mode` | [*components.AlignmentPluginMode](../../models/components/alignmentpluginmode.mdx) | :heavy_minus_sign: | `enforce`: a turn that breaks a rule is withheld, retried, and finally returned as an error. `audit`: every turn is evaluated and returned. Default `enforce`. | | +| `Rules` | []`string` | :heavy_check_mark: | Texts that state what the reply must do or must not do. Each rule is evaluated on its own. | [
"Never offer a discount.",
"End with exactly one question."
] | +| `Threshold` | `*float64` | :heavy_minus_sign: | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file diff --git a/docs/models/components/alignmentrulerecord.mdx b/docs/models/components/alignmentrulerecord.mdx index 32a0e7e17..9c2288506 100644 --- a/docs/models/components/alignmentrulerecord.mdx +++ b/docs/models/components/alignmentrulerecord.mdx @@ -6,5 +6,5 @@ title: "AlignmentRuleRecord" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Broken` | `bool` | ✅ | Whether probability is at or above the threshold. | -| `Probability` | `float64` | ✅ | The evaluator's probability that the turn breaks the rule. | \ No newline at end of file +| `Broken` | `bool` | :heavy_check_mark: | Whether probability is at or above the threshold. | +| `Probability` | `float64` | :heavy_check_mark: | The evaluator's probability that the turn breaks the rule. | \ No newline at end of file diff --git a/docs/models/components/alignmentunavailablecallrecord.mdx b/docs/models/components/alignmentunavailablecallrecord.mdx index 8fe4b317f..53c05b2d0 100644 --- a/docs/models/components/alignmentunavailablecallrecord.mdx +++ b/docs/models/components/alignmentunavailablecallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentUnavailableCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Call` | `int64` | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `Outcome` | [components.AlignmentUnavailableCallRecordOutcome](../../models/components/alignmentunavailablecallrecordoutcome.mdx) | ✅ | N/A | -| `Reason` | [components.AlignmentUnavailableCallRecordReason](../../models/components/alignmentunavailablecallrecordreason.mdx) | ✅ | N/A | \ No newline at end of file +| `Call` | `int64` | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `Outcome` | [components.AlignmentUnavailableCallRecordOutcome](../../models/components/alignmentunavailablecallrecordoutcome.mdx) | :heavy_check_mark: | N/A | +| `Reason` | [components.AlignmentUnavailableCallRecordReason](../../models/components/alignmentunavailablecallrecordreason.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/allowedtools.mdx b/docs/models/components/allowedtools.mdx index 3c7405e89..cee77733f 100644 --- a/docs/models/components/allowedtools.mdx +++ b/docs/models/components/allowedtools.mdx @@ -6,5 +6,5 @@ title: "AllowedTools" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ReadOnly` | `*bool` | ➖ | N/A | -| `ToolNames` | []`string` | ➖ | N/A | \ No newline at end of file +| `ReadOnly` | `*bool` | :heavy_minus_sign: | N/A | +| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/always.mdx b/docs/models/components/always.mdx index 6b42f544b..a10039076 100644 --- a/docs/models/components/always.mdx +++ b/docs/models/components/always.mdx @@ -6,4 +6,4 @@ title: "Always" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ToolNames` | []`string` | ➖ | N/A | \ No newline at end of file +| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/annotationaddedevent.mdx b/docs/models/components/annotationaddedevent.mdx index 38d5fa678..d7a722dc5 100644 --- a/docs/models/components/annotationaddedevent.mdx +++ b/docs/models/components/annotationaddedevent.mdx @@ -9,10 +9,10 @@ Event emitted when a text annotation is added to output | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Annotation` | [components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | ✅ | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | -| `AnnotationIndex` | `int64` | ✅ | N/A | | -| `ContentIndex` | `int64` | ✅ | N/A | | -| `ItemID` | `string` | ✅ | N/A | | -| `OutputIndex` | `int64` | ✅ | N/A | | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.AnnotationAddedEventType](../../models/components/annotationaddedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Annotation` | [components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | :heavy_check_mark: | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | +| `AnnotationIndex` | `int64` | :heavy_check_mark: | N/A | | +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | | +| `ItemID` | `string` | :heavy_check_mark: | N/A | | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnnotationAddedEventType](../../models/components/annotationaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/annotationfile.mdx b/docs/models/components/annotationfile.mdx index 23f8622dd..bfd4ada5d 100644 --- a/docs/models/components/annotationfile.mdx +++ b/docs/models/components/annotationfile.mdx @@ -6,5 +6,5 @@ title: "AnnotationFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `File` | [components.BatchObjectFile](../../models/components/batchobjectfile.mdx) | ✅ | N/A | -| `Type` | [components.AnnotationTypeFile](../../models/components/annotationtypefile.mdx) | ✅ | N/A | \ No newline at end of file +| `File` | [components.BatchObjectFile](../../models/components/batchobjectfile.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnnotationTypeFile](../../models/components/annotationtypefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/annotationurlcitation.mdx b/docs/models/components/annotationurlcitation.mdx index 8d77c0f4e..5cc8d6770 100644 --- a/docs/models/components/annotationurlcitation.mdx +++ b/docs/models/components/annotationurlcitation.mdx @@ -6,5 +6,5 @@ title: "AnnotationURLCitation" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnnotationTypeURLCitation](../../models/components/annotationtypeurlcitation.mdx) | ✅ | N/A | -| `URLCitation` | [components.BatchObjectURLCitation](../../models/components/batchobjecturlcitation.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnnotationTypeURLCitation](../../models/components/annotationtypeurlcitation.mdx) | :heavy_check_mark: | N/A | +| `URLCitation` | [components.BatchObjectURLCitation](../../models/components/batchobjecturlcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/annotationwebsearchcitation.mdx b/docs/models/components/annotationwebsearchcitation.mdx index 3f3d9cbbe..ca239e366 100644 --- a/docs/models/components/annotationwebsearchcitation.mdx +++ b/docs/models/components/annotationwebsearchcitation.mdx @@ -6,5 +6,5 @@ title: "AnnotationWebSearchCitation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.TypeWebSearchCitation](../../models/components/typewebsearchcitation.mdx) | ✅ | N/A | -| `WebSearchCitation` | [components.WebSearchCitation](../../models/components/websearchcitation.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.TypeWebSearchCitation](../../models/components/typewebsearchcitation.mdx) | :heavy_check_mark: | N/A | +| `WebSearchCitation` | [components.WebSearchCitation](../../models/components/websearchcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicadvisormessageusageiteration.mdx b/docs/models/components/anthropicadvisormessageusageiteration.mdx index 496027c36..ee2480e10 100644 --- a/docs/models/components/anthropicadvisormessageusageiteration.mdx +++ b/docs/models/components/anthropicadvisormessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicAdvisorMessageUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `CacheCreationInputTokens` | `*int64` | ➖ | N/A | | -| `CacheReadInputTokens` | `*int64` | ➖ | N/A | | -| `InputTokens` | `*int64` | ➖ | N/A | | -| `OutputTokens` | `*int64` | ➖ | N/A | | -| `Model` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicAdvisorMessageUsageIterationType](../../models/components/anthropicadvisormessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicAdvisorMessageUsageIterationType](../../models/components/anthropicadvisormessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicadvisortoolresult.mdx b/docs/models/components/anthropicadvisortoolresult.mdx index 3c408c4f4..24988a6f8 100644 --- a/docs/models/components/anthropicadvisortoolresult.mdx +++ b/docs/models/components/anthropicadvisortoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicAdvisorToolResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Content` | map[string]`any` | ✅ | N/A | -| `ToolUseID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicAdvisorToolResultType](../../models/components/anthropicadvisortoolresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | map[string]`any` | :heavy_check_mark: | N/A | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicAdvisorToolResultType](../../models/components/anthropicadvisortoolresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicbase64imagesource.mdx b/docs/models/components/anthropicbase64imagesource.mdx index d7d52212a..b97e64b9a 100644 --- a/docs/models/components/anthropicbase64imagesource.mdx +++ b/docs/models/components/anthropicbase64imagesource.mdx @@ -6,6 +6,6 @@ title: "AnthropicBase64ImageSource" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | ✅ | N/A | | -| `MediaType` | [components.AnthropicImageMimeType](../../models/components/anthropicimagemimetype.mdx) | ✅ | N/A | image/jpeg | -| `Type` | [components.AnthropicBase64ImageSourceType](../../models/components/anthropicbase64imagesourcetype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | N/A | | +| `MediaType` | [components.AnthropicImageMimeType](../../models/components/anthropicimagemimetype.mdx) | :heavy_check_mark: | N/A | image/jpeg | +| `Type` | [components.AnthropicBase64ImageSourceType](../../models/components/anthropicbase64imagesourcetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicbase64pdfsource.mdx b/docs/models/components/anthropicbase64pdfsource.mdx index fefa9d30c..85776a1e9 100644 --- a/docs/models/components/anthropicbase64pdfsource.mdx +++ b/docs/models/components/anthropicbase64pdfsource.mdx @@ -6,6 +6,6 @@ title: "AnthropicBase64PdfSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | ✅ | N/A | -| `MediaType` | [components.AnthropicBase64PdfSourceMediaType](../../models/components/anthropicbase64pdfsourcemediatype.mdx) | ✅ | N/A | -| `Type` | [components.AnthropicBase64PdfSourceType](../../models/components/anthropicbase64pdfsourcetype.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | N/A | +| `MediaType` | [components.AnthropicBase64PdfSourceMediaType](../../models/components/anthropicbase64pdfsourcemediatype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicBase64PdfSourceType](../../models/components/anthropicbase64pdfsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicbashcodeexecutionoutput.mdx b/docs/models/components/anthropicbashcodeexecutionoutput.mdx index 87c751afa..defdf13c3 100644 --- a/docs/models/components/anthropicbashcodeexecutionoutput.mdx +++ b/docs/models/components/anthropicbashcodeexecutionoutput.mdx @@ -6,5 +6,5 @@ title: "AnthropicBashCodeExecutionOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `FileID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicBashCodeExecutionOutputType](../../models/components/anthropicbashcodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicBashCodeExecutionOutputType](../../models/components/anthropicbashcodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicbashcodeexecutionresult.mdx b/docs/models/components/anthropicbashcodeexecutionresult.mdx index a0177b3e9..e797c53ee 100644 --- a/docs/models/components/anthropicbashcodeexecutionresult.mdx +++ b/docs/models/components/anthropicbashcodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicBashCodeExecutionResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Content` | [][components.AnthropicBashCodeExecutionOutput](../../models/components/anthropicbashcodeexecutionoutput.mdx) | ✅ | N/A | -| `ReturnCode` | `int64` | ✅ | N/A | -| `Stderr` | `string` | ✅ | N/A | -| `Stdout` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicBashCodeExecutionResultType](../../models/components/anthropicbashcodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [][components.AnthropicBashCodeExecutionOutput](../../models/components/anthropicbashcodeexecutionoutput.mdx) | :heavy_check_mark: | N/A | +| `ReturnCode` | `int64` | :heavy_check_mark: | N/A | +| `Stderr` | `string` | :heavy_check_mark: | N/A | +| `Stdout` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicBashCodeExecutionResultType](../../models/components/anthropicbashcodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicbashcodeexecutiontoolresult.mdx b/docs/models/components/anthropicbashcodeexecutiontoolresult.mdx index 850040fe0..87ccab406 100644 --- a/docs/models/components/anthropicbashcodeexecutiontoolresult.mdx +++ b/docs/models/components/anthropicbashcodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicBashCodeExecutionToolResult" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicBashCodeExecutionContent](../../models/components/anthropicbashcodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | -| `ToolUseID` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicBashCodeExecutionToolResultType](../../models/components/anthropicbashcodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicBashCodeExecutionContent](../../models/components/anthropicbashcodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicBashCodeExecutionToolResultType](../../models/components/anthropicbashcodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicbashcodeexecutiontoolresulterror.mdx b/docs/models/components/anthropicbashcodeexecutiontoolresulterror.mdx index a14f2efa7..32a63b39d 100644 --- a/docs/models/components/anthropicbashcodeexecutiontoolresulterror.mdx +++ b/docs/models/components/anthropicbashcodeexecutiontoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicBashCodeExecutionToolResultError" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicBashCodeExecutionToolResultErrorErrorCode](../../models/components/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | -| `Type` | [components.AnthropicBashCodeExecutionToolResultErrorType](../../models/components/anthropicbashcodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `ErrorCode` | [components.AnthropicBashCodeExecutionToolResultErrorErrorCode](../../models/components/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicBashCodeExecutionToolResultErrorType](../../models/components/anthropicbashcodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccachecontroldirective.mdx b/docs/models/components/anthropiccachecontroldirective.mdx index 33f489d21..ef3026af8 100644 --- a/docs/models/components/anthropiccachecontroldirective.mdx +++ b/docs/models/components/anthropiccachecontroldirective.mdx @@ -9,5 +9,5 @@ Enable automatic prompt caching. When set at the top level, the system automatic | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | -| `Type` | [components.AnthropicCacheControlDirectiveType](../../models/components/anthropiccachecontroldirectivetype.mdx) | ✅ | N/A | | \ No newline at end of file +| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | +| `Type` | [components.AnthropicCacheControlDirectiveType](../../models/components/anthropiccachecontroldirectivetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccachecreation.mdx b/docs/models/components/anthropiccachecreation.mdx index 7e84b6259..e8d95fc3a 100644 --- a/docs/models/components/anthropiccachecreation.mdx +++ b/docs/models/components/anthropiccachecreation.mdx @@ -6,5 +6,5 @@ title: "AnthropicCacheCreation" | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `Ephemeral1hInputTokens` | `int64` | ✅ | N/A | -| `Ephemeral5mInputTokens` | `int64` | ✅ | N/A | \ No newline at end of file +| `Ephemeral1hInputTokens` | `int64` | :heavy_check_mark: | N/A | +| `Ephemeral5mInputTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcharlocation.mdx b/docs/models/components/anthropiccitationcharlocation.mdx index 9d0470705..cebeb99f2 100644 --- a/docs/models/components/anthropiccitationcharlocation.mdx +++ b/docs/models/components/anthropiccitationcharlocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationCharLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `CitedText` | `string` | ✅ | N/A | -| `DocumentIndex` | `int64` | ✅ | N/A | -| `DocumentTitle` | `*string` | ✅ | N/A | -| `EndCharIndex` | `int64` | ✅ | N/A | -| `FileID` | `*string` | ✅ | N/A | -| `StartCharIndex` | `int64` | ✅ | N/A | -| `Type` | [components.AnthropicCitationCharLocationType](../../models/components/anthropiccitationcharlocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | +| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | +| `EndCharIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `*string` | :heavy_check_mark: | N/A | +| `StartCharIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationCharLocationType](../../models/components/anthropiccitationcharlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcharlocationparam.mdx b/docs/models/components/anthropiccitationcharlocationparam.mdx index c36e2c0c5..98984ed1f 100644 --- a/docs/models/components/anthropiccitationcharlocationparam.mdx +++ b/docs/models/components/anthropiccitationcharlocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationCharLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | ✅ | N/A | -| `DocumentIndex` | `int64` | ✅ | N/A | -| `DocumentTitle` | `*string` | ✅ | N/A | -| `EndCharIndex` | `int64` | ✅ | N/A | -| `StartCharIndex` | `int64` | ✅ | N/A | -| `Type` | [components.AnthropicCitationCharLocationParamType](../../models/components/anthropiccitationcharlocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | +| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | +| `EndCharIndex` | `int64` | :heavy_check_mark: | N/A | +| `StartCharIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationCharLocationParamType](../../models/components/anthropiccitationcharlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcontentblocklocation.mdx b/docs/models/components/anthropiccitationcontentblocklocation.mdx index 8362cf22e..9ec31455a 100644 --- a/docs/models/components/anthropiccitationcontentblocklocation.mdx +++ b/docs/models/components/anthropiccitationcontentblocklocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationContentBlockLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | ✅ | N/A | -| `DocumentIndex` | `int64` | ✅ | N/A | -| `DocumentTitle` | `*string` | ✅ | N/A | -| `EndBlockIndex` | `int64` | ✅ | N/A | -| `FileID` | `*string` | ✅ | N/A | -| `StartBlockIndex` | `int64` | ✅ | N/A | -| `Type` | [components.AnthropicCitationContentBlockLocationType](../../models/components/anthropiccitationcontentblocklocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | +| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | +| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `*string` | :heavy_check_mark: | N/A | +| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationContentBlockLocationType](../../models/components/anthropiccitationcontentblocklocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcontentblocklocationparam.mdx b/docs/models/components/anthropiccitationcontentblocklocationparam.mdx index 58bf17c2f..76be2e879 100644 --- a/docs/models/components/anthropiccitationcontentblocklocationparam.mdx +++ b/docs/models/components/anthropiccitationcontentblocklocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationContentBlockLocationParam" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | ✅ | N/A | -| `DocumentIndex` | `int64` | ✅ | N/A | -| `DocumentTitle` | `*string` | ✅ | N/A | -| `EndBlockIndex` | `int64` | ✅ | N/A | -| `StartBlockIndex` | `int64` | ✅ | N/A | -| `Type` | [components.AnthropicCitationContentBlockLocationParamType](../../models/components/anthropiccitationcontentblocklocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | +| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | +| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | +| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationContentBlockLocationParamType](../../models/components/anthropiccitationcontentblocklocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationpagelocation.mdx b/docs/models/components/anthropiccitationpagelocation.mdx index e64e79c1c..99c4f41f3 100644 --- a/docs/models/components/anthropiccitationpagelocation.mdx +++ b/docs/models/components/anthropiccitationpagelocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationPageLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `CitedText` | `string` | ✅ | N/A | -| `DocumentIndex` | `int64` | ✅ | N/A | -| `DocumentTitle` | `*string` | ✅ | N/A | -| `EndPageNumber` | `int64` | ✅ | N/A | -| `FileID` | `*string` | ✅ | N/A | -| `StartPageNumber` | `int64` | ✅ | N/A | -| `Type` | [components.AnthropicCitationPageLocationType](../../models/components/anthropiccitationpagelocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | +| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | +| `EndPageNumber` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `*string` | :heavy_check_mark: | N/A | +| `StartPageNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationPageLocationType](../../models/components/anthropiccitationpagelocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationpagelocationparam.mdx b/docs/models/components/anthropiccitationpagelocationparam.mdx index 8b792d493..aa8bcb3ca 100644 --- a/docs/models/components/anthropiccitationpagelocationparam.mdx +++ b/docs/models/components/anthropiccitationpagelocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationPageLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | ✅ | N/A | -| `DocumentIndex` | `int64` | ✅ | N/A | -| `DocumentTitle` | `*string` | ✅ | N/A | -| `EndPageNumber` | `int64` | ✅ | N/A | -| `StartPageNumber` | `int64` | ✅ | N/A | -| `Type` | [components.AnthropicCitationPageLocationParamType](../../models/components/anthropiccitationpagelocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | +| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | +| `EndPageNumber` | `int64` | :heavy_check_mark: | N/A | +| `StartPageNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationPageLocationParamType](../../models/components/anthropiccitationpagelocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationsconfig.mdx b/docs/models/components/anthropiccitationsconfig.mdx index c4a7215ec..54f28d5f3 100644 --- a/docs/models/components/anthropiccitationsconfig.mdx +++ b/docs/models/components/anthropiccitationsconfig.mdx @@ -6,4 +6,4 @@ title: "AnthropicCitationsConfig" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Enabled` | `bool` | ✅ | N/A | \ No newline at end of file +| `Enabled` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationsearchresultlocation.mdx b/docs/models/components/anthropiccitationsearchresultlocation.mdx index e6dba4394..5916941fb 100644 --- a/docs/models/components/anthropiccitationsearchresultlocation.mdx +++ b/docs/models/components/anthropiccitationsearchresultlocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationSearchResultLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | ✅ | N/A | -| `EndBlockIndex` | `int64` | ✅ | N/A | -| `SearchResultIndex` | `int64` | ✅ | N/A | -| `Source` | `string` | ✅ | N/A | -| `StartBlockIndex` | `int64` | ✅ | N/A | -| `Title` | `*string` | ✅ | N/A | -| `Type` | [components.AnthropicCitationSearchResultLocationType](../../models/components/anthropiccitationsearchresultlocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | +| `SearchResultIndex` | `int64` | :heavy_check_mark: | N/A | +| `Source` | `string` | :heavy_check_mark: | N/A | +| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | +| `Title` | `*string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationSearchResultLocationType](../../models/components/anthropiccitationsearchresultlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationsearchresultlocationparam.mdx b/docs/models/components/anthropiccitationsearchresultlocationparam.mdx index 35e524b18..05ae11135 100644 --- a/docs/models/components/anthropiccitationsearchresultlocationparam.mdx +++ b/docs/models/components/anthropiccitationsearchresultlocationparam.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationSearchResultLocationParam" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | ✅ | N/A | -| `EndBlockIndex` | `int64` | ✅ | N/A | -| `SearchResultIndex` | `int64` | ✅ | N/A | -| `Source` | `string` | ✅ | N/A | -| `StartBlockIndex` | `int64` | ✅ | N/A | -| `Title` | `*string` | ✅ | N/A | -| `Type` | [components.AnthropicCitationSearchResultLocationParamType](../../models/components/anthropiccitationsearchresultlocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | +| `SearchResultIndex` | `int64` | :heavy_check_mark: | N/A | +| `Source` | `string` | :heavy_check_mark: | N/A | +| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | +| `Title` | `*string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationSearchResultLocationParamType](../../models/components/anthropiccitationsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationwebsearchresultlocation.mdx b/docs/models/components/anthropiccitationwebsearchresultlocation.mdx index 0c56e2d2a..ffcafe169 100644 --- a/docs/models/components/anthropiccitationwebsearchresultlocation.mdx +++ b/docs/models/components/anthropiccitationwebsearchresultlocation.mdx @@ -6,8 +6,8 @@ title: "AnthropicCitationWebSearchResultLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | ✅ | N/A | -| `EncryptedIndex` | `string` | ✅ | N/A | -| `Title` | `*string` | ✅ | N/A | -| `Type` | [components.AnthropicCitationWebSearchResultLocationType](../../models/components/anthropiccitationwebsearchresultlocationtype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `EncryptedIndex` | `string` | :heavy_check_mark: | N/A | +| `Title` | `*string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationWebSearchResultLocationType](../../models/components/anthropiccitationwebsearchresultlocationtype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx b/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx index 3b5d7ea3d..cb7994873 100644 --- a/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx +++ b/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx @@ -6,8 +6,8 @@ title: "AnthropicCitationWebSearchResultLocationParam" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | ✅ | N/A | -| `EncryptedIndex` | `string` | ✅ | N/A | -| `Title` | `*string` | ✅ | N/A | -| `Type` | [components.AnthropicCitationWebSearchResultLocationParamType](../../models/components/anthropiccitationwebsearchresultlocationparamtype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `CitedText` | `string` | :heavy_check_mark: | N/A | +| `EncryptedIndex` | `string` | :heavy_check_mark: | N/A | +| `Title` | `*string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationWebSearchResultLocationParamType](../../models/components/anthropiccitationwebsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecution20250825caller.mdx b/docs/models/components/anthropiccodeexecution20250825caller.mdx index bc63b65bf..72eda21ff 100644 --- a/docs/models/components/anthropiccodeexecution20250825caller.mdx +++ b/docs/models/components/anthropiccodeexecution20250825caller.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecution20250825Caller" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `ToolID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicCodeExecution20250825CallerType](../../models/components/anthropiccodeexecution20250825callertype.mdx) | ✅ | N/A | \ No newline at end of file +| `ToolID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCodeExecution20250825CallerType](../../models/components/anthropiccodeexecution20250825callertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecution20260120caller.mdx b/docs/models/components/anthropiccodeexecution20260120caller.mdx index 5bd070a52..4b36ea291 100644 --- a/docs/models/components/anthropiccodeexecution20260120caller.mdx +++ b/docs/models/components/anthropiccodeexecution20260120caller.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecution20260120Caller" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `ToolID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicCodeExecution20260120CallerType](../../models/components/anthropiccodeexecution20260120callertype.mdx) | ✅ | N/A | \ No newline at end of file +| `ToolID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCodeExecution20260120CallerType](../../models/components/anthropiccodeexecution20260120callertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecutionoutput.mdx b/docs/models/components/anthropiccodeexecutionoutput.mdx index fb5fc50d6..442188475 100644 --- a/docs/models/components/anthropiccodeexecutionoutput.mdx +++ b/docs/models/components/anthropiccodeexecutionoutput.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecutionOutput" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `FileID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicCodeExecutionOutputType](../../models/components/anthropiccodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCodeExecutionOutputType](../../models/components/anthropiccodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecutionresult.mdx b/docs/models/components/anthropiccodeexecutionresult.mdx index a28b903a8..d0a75567d 100644 --- a/docs/models/components/anthropiccodeexecutionresult.mdx +++ b/docs/models/components/anthropiccodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicCodeExecutionResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.AnthropicCodeExecutionOutput](../../models/components/anthropiccodeexecutionoutput.mdx) | ✅ | N/A | -| `ReturnCode` | `int64` | ✅ | N/A | -| `Stderr` | `string` | ✅ | N/A | -| `Stdout` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicCodeExecutionResultType](../../models/components/anthropiccodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [][components.AnthropicCodeExecutionOutput](../../models/components/anthropiccodeexecutionoutput.mdx) | :heavy_check_mark: | N/A | +| `ReturnCode` | `int64` | :heavy_check_mark: | N/A | +| `Stderr` | `string` | :heavy_check_mark: | N/A | +| `Stdout` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCodeExecutionResultType](../../models/components/anthropiccodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecutiontoolresult.mdx b/docs/models/components/anthropiccodeexecutiontoolresult.mdx index d9e018d0c..fe3ed6725 100644 --- a/docs/models/components/anthropiccodeexecutiontoolresult.mdx +++ b/docs/models/components/anthropiccodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicCodeExecutionToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Content` | [components.AnthropicCodeExecutionContent](../../models/components/anthropiccodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | -| `ToolUseID` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicCodeExecutionToolResultType](../../models/components/anthropiccodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicCodeExecutionContent](../../models/components/anthropiccodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicCodeExecutionToolResultType](../../models/components/anthropiccodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecutiontoolresulterror.mdx b/docs/models/components/anthropiccodeexecutiontoolresulterror.mdx index ab4ee97cf..c0a1af1ba 100644 --- a/docs/models/components/anthropiccodeexecutiontoolresulterror.mdx +++ b/docs/models/components/anthropiccodeexecutiontoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecutionToolResultError" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicServerToolErrorCode](../../models/components/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | -| `Type` | [components.AnthropicCodeExecutionToolResultErrorType](../../models/components/anthropiccodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ErrorCode` | [components.AnthropicServerToolErrorCode](../../models/components/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | +| `Type` | [components.AnthropicCodeExecutionToolResultErrorType](../../models/components/anthropiccodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccompactionblock.mdx b/docs/models/components/anthropiccompactionblock.mdx index 60a2c7d40..1ce70ccfc 100644 --- a/docs/models/components/anthropiccompactionblock.mdx +++ b/docs/models/components/anthropiccompactionblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicCompactionBlock" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Content` | `*string` | ✅ | N/A | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.AnthropicCompactionBlockType](../../models/components/anthropiccompactionblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | `*string` | :heavy_check_mark: | N/A | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.AnthropicCompactionBlockType](../../models/components/anthropiccompactionblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccompactionusageiteration.mdx b/docs/models/components/anthropiccompactionusageiteration.mdx index 3c9d0a507..dd4c89650 100644 --- a/docs/models/components/anthropiccompactionusageiteration.mdx +++ b/docs/models/components/anthropiccompactionusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicCompactionUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `CacheCreationInputTokens` | `*int64` | ➖ | N/A | | -| `CacheReadInputTokens` | `*int64` | ➖ | N/A | | -| `InputTokens` | `*int64` | ➖ | N/A | | -| `OutputTokens` | `*int64` | ➖ | N/A | | -| `Type` | [components.AnthropicCompactionUsageIterationType](../../models/components/anthropiccompactionusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `Type` | [components.AnthropicCompactionUsageIterationType](../../models/components/anthropiccompactionusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccontainer.mdx b/docs/models/components/anthropiccontainer.mdx index 3a5756b6d..2cdc5ab7a 100644 --- a/docs/models/components/anthropiccontainer.mdx +++ b/docs/models/components/anthropiccontainer.mdx @@ -6,6 +6,6 @@ title: "AnthropicContainer" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `ExpiresAt` | `string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Skills` | optionalnullable.OptionalNullable[[][components.AnthropicContainerSkill](../../models/components/anthropiccontainerskill.mdx)] | ➖ | N/A | \ No newline at end of file +| `ExpiresAt` | `string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Skills` | optionalnullable.OptionalNullable[[][components.AnthropicContainerSkill](../../models/components/anthropiccontainerskill.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccontainerskill.mdx b/docs/models/components/anthropiccontainerskill.mdx index 0c893ccda..68f4fe1a6 100644 --- a/docs/models/components/anthropiccontainerskill.mdx +++ b/docs/models/components/anthropiccontainerskill.mdx @@ -6,6 +6,6 @@ title: "AnthropicContainerSkill" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `SkillID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicContainerSkillType](../../models/components/anthropiccontainerskilltype.mdx) | ✅ | N/A | -| `Version` | `string` | ✅ | N/A | \ No newline at end of file +| `SkillID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicContainerSkillType](../../models/components/anthropiccontainerskilltype.mdx) | :heavy_check_mark: | N/A | +| `Version` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccontainerupload.mdx b/docs/models/components/anthropiccontainerupload.mdx index 63b89f4ea..63fc64996 100644 --- a/docs/models/components/anthropiccontainerupload.mdx +++ b/docs/models/components/anthropiccontainerupload.mdx @@ -6,5 +6,5 @@ title: "AnthropicContainerUpload" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `FileID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicContainerUploadType](../../models/components/anthropiccontaineruploadtype.mdx) | ✅ | N/A | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicContainerUploadType](../../models/components/anthropiccontaineruploadtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicdirectcaller.mdx b/docs/models/components/anthropicdirectcaller.mdx index c2f48f738..7c1fce85a 100644 --- a/docs/models/components/anthropicdirectcaller.mdx +++ b/docs/models/components/anthropicdirectcaller.mdx @@ -6,4 +6,4 @@ title: "AnthropicDirectCaller" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicDirectCallerType](../../models/components/anthropicdirectcallertype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnthropicDirectCallerType](../../models/components/anthropicdirectcallertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicdocumentblock.mdx b/docs/models/components/anthropicdocumentblock.mdx index 4ebf70d52..bebd292e3 100644 --- a/docs/models/components/anthropicdocumentblock.mdx +++ b/docs/models/components/anthropicdocumentblock.mdx @@ -6,7 +6,7 @@ title: "AnthropicDocumentBlock" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicCitationsConfig](../../models/components/anthropiccitationsconfig.mdx)] | ➖ | N/A | \{
"enabled": true
} | -| `Source` | [components.AnthropicDocumentBlockSource](../../models/components/anthropicdocumentblocksource.mdx) | ✅ | N/A | | -| `Title` | `*string` | ✅ | N/A | | -| `Type` | [components.AnthropicDocumentBlockType](../../models/components/anthropicdocumentblocktype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicCitationsConfig](../../models/components/anthropiccitationsconfig.mdx)] | :heavy_minus_sign: | N/A | \{
"enabled": true
} | +| `Source` | [components.AnthropicDocumentBlockSource](../../models/components/anthropicdocumentblocksource.mdx) | :heavy_check_mark: | N/A | | +| `Title` | `*string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicDocumentBlockType](../../models/components/anthropicdocumentblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicdocumentblockparam.mdx b/docs/models/components/anthropicdocumentblockparam.mdx index 0f79f0bae..6f957394d 100644 --- a/docs/models/components/anthropicdocumentblockparam.mdx +++ b/docs/models/components/anthropicdocumentblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicDocumentBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicDocumentBlockParamCitations](../../models/components/anthropicdocumentblockparamcitations.mdx)] | ➖ | N/A | | -| `Context` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Source` | [components.AnthropicDocumentBlockParamSourceUnion](../../models/components/anthropicdocumentblockparamsourceunion.mdx) | ✅ | N/A | | -| `Title` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Type` | [components.AnthropicDocumentBlockParamTypeDocument](../../models/components/anthropicdocumentblockparamtypedocument.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicDocumentBlockParamCitations](../../models/components/anthropicdocumentblockparamcitations.mdx)] | :heavy_minus_sign: | N/A | | +| `Context` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Source` | [components.AnthropicDocumentBlockParamSourceUnion](../../models/components/anthropicdocumentblockparamsourceunion.mdx) | :heavy_check_mark: | N/A | | +| `Title` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.AnthropicDocumentBlockParamTypeDocument](../../models/components/anthropicdocumentblockparamtypedocument.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicdocumentblockparamcitations.mdx b/docs/models/components/anthropicdocumentblockparamcitations.mdx index 02eff1971..4aa238324 100644 --- a/docs/models/components/anthropicdocumentblockparamcitations.mdx +++ b/docs/models/components/anthropicdocumentblockparamcitations.mdx @@ -6,4 +6,4 @@ title: "AnthropicDocumentBlockParamCitations" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Enabled` | `*bool` | ➖ | N/A | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicencryptedcodeexecutionresult.mdx b/docs/models/components/anthropicencryptedcodeexecutionresult.mdx index b876203f4..f40f74b89 100644 --- a/docs/models/components/anthropicencryptedcodeexecutionresult.mdx +++ b/docs/models/components/anthropicencryptedcodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicEncryptedCodeExecutionResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.AnthropicCodeExecutionOutput](../../models/components/anthropiccodeexecutionoutput.mdx) | ✅ | N/A | -| `EncryptedStdout` | `string` | ✅ | N/A | -| `ReturnCode` | `int64` | ✅ | N/A | -| `Stderr` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicEncryptedCodeExecutionResultType](../../models/components/anthropicencryptedcodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [][components.AnthropicCodeExecutionOutput](../../models/components/anthropiccodeexecutionoutput.mdx) | :heavy_check_mark: | N/A | +| `EncryptedStdout` | `string` | :heavy_check_mark: | N/A | +| `ReturnCode` | `int64` | :heavy_check_mark: | N/A | +| `Stderr` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicEncryptedCodeExecutionResultType](../../models/components/anthropicencryptedcodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfile.mdx b/docs/models/components/anthropicfile.mdx index 608f8ac0b..df8cc5a0b 100644 --- a/docs/models/components/anthropicfile.mdx +++ b/docs/models/components/anthropicfile.mdx @@ -9,11 +9,11 @@ A stored file in Anthropic's Files API shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Shape` | [components.AnthropicFileShape](../../models/components/anthropicfileshape.mdx) | ✅ | N/A | -| `CreatedAt` | `string` | ✅ | N/A | -| `Downloadable` | `bool` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `MimeType` | `string` | ✅ | N/A | -| `SizeBytes` | `int64` | ✅ | N/A | -| `Type` | [components.AnthropicFileType](../../models/components/anthropicfiletype.mdx) | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.AnthropicFileShape](../../models/components/anthropicfileshape.mdx) | :heavy_check_mark: | N/A | +| `CreatedAt` | `string` | :heavy_check_mark: | N/A | +| `Downloadable` | `bool` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `MimeType` | `string` | :heavy_check_mark: | N/A | +| `SizeBytes` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicFileType](../../models/components/anthropicfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfiledeleted.mdx b/docs/models/components/anthropicfiledeleted.mdx index ccbdc8793..e62527293 100644 --- a/docs/models/components/anthropicfiledeleted.mdx +++ b/docs/models/components/anthropicfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in Anthropic's shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Shape` | [components.AnthropicFileDeletedShape](../../models/components/anthropicfiledeletedshape.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicFileDeletedType](../../models/components/anthropicfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.AnthropicFileDeletedShape](../../models/components/anthropicfiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicFileDeletedType](../../models/components/anthropicfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfiledocumentsource.mdx b/docs/models/components/anthropicfiledocumentsource.mdx index 98a6f3787..232e3fd8c 100644 --- a/docs/models/components/anthropicfiledocumentsource.mdx +++ b/docs/models/components/anthropicfiledocumentsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicFileDocumentSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `FileID` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicFileDocumentSourceType](../../models/components/anthropicfiledocumentsourcetype.mdx) | ✅ | N/A | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicFileDocumentSourceType](../../models/components/anthropicfiledocumentsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfilelist.mdx b/docs/models/components/anthropicfilelist.mdx index ec78228a9..f8c77f70d 100644 --- a/docs/models/components/anthropicfilelist.mdx +++ b/docs/models/components/anthropicfilelist.mdx @@ -9,8 +9,8 @@ A page of files in Anthropic's shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Shape` | [components.AnthropicFileListShape](../../models/components/anthropicfilelistshape.mdx) | ✅ | N/A | -| `Data` | [][components.AnthropicFile](../../models/components/anthropicfile.mdx) | ✅ | N/A | -| `FirstID` | `*string` | ✅ | N/A | -| `HasMore` | `bool` | ✅ | N/A | -| `LastID` | `*string` | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.AnthropicFileListShape](../../models/components/anthropicfilelistshape.mdx) | :heavy_check_mark: | N/A | +| `Data` | [][components.AnthropicFile](../../models/components/anthropicfile.mdx) | :heavy_check_mark: | N/A | +| `FirstID` | `*string` | :heavy_check_mark: | N/A | +| `HasMore` | `bool` | :heavy_check_mark: | N/A | +| `LastID` | `*string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicimageblockparam.mdx b/docs/models/components/anthropicimageblockparam.mdx index 8e051054f..55384b6a6 100644 --- a/docs/models/components/anthropicimageblockparam.mdx +++ b/docs/models/components/anthropicimageblockparam.mdx @@ -6,6 +6,6 @@ title: "AnthropicImageBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Source` | [components.AnthropicImageBlockParamSource](../../models/components/anthropicimageblockparamsource.mdx) | ✅ | N/A | | -| `Type` | [components.AnthropicImageBlockParamType](../../models/components/anthropicimageblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Source` | [components.AnthropicImageBlockParamSource](../../models/components/anthropicimageblockparamsource.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicImageBlockParamType](../../models/components/anthropicimageblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicinputtokensclearatleast.mdx b/docs/models/components/anthropicinputtokensclearatleast.mdx index be72bd1cd..4f0705672 100644 --- a/docs/models/components/anthropicinputtokensclearatleast.mdx +++ b/docs/models/components/anthropicinputtokensclearatleast.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensClearAtLeast" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.AnthropicInputTokensClearAtLeastType](../../models/components/anthropicinputtokensclearatleasttype.mdx) | ✅ | N/A | -| `Value` | `int64` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnthropicInputTokensClearAtLeastType](../../models/components/anthropicinputtokensclearatleasttype.mdx) | :heavy_check_mark: | N/A | +| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicinputtokenstrigger.mdx b/docs/models/components/anthropicinputtokenstrigger.mdx index 8320f5f09..30868cc63 100644 --- a/docs/models/components/anthropicinputtokenstrigger.mdx +++ b/docs/models/components/anthropicinputtokenstrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensTrigger" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicInputTokensTriggerType](../../models/components/anthropicinputtokenstriggertype.mdx) | ✅ | N/A | -| `Value` | `int64` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnthropicInputTokensTriggerType](../../models/components/anthropicinputtokenstriggertype.mdx) | :heavy_check_mark: | N/A | +| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicinputtransformation.mdx b/docs/models/components/anthropicinputtransformation.mdx index e29a5d8ab..ae0ffff19 100644 --- a/docs/models/components/anthropicinputtransformation.mdx +++ b/docs/models/components/anthropicinputtransformation.mdx @@ -9,7 +9,7 @@ A server-side transformation Anthropic applied to the request input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Path` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Reason` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Type` | `string` | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"path": "messages.1.content.0",
"reason": "prefix_binding_mismatch",
"type": "thinking_dropped"
} | \ No newline at end of file +| `Path` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Reason` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Type` | `string` | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"path": "messages.1.content.0",
"reason": "prefix_binding_mismatch",
"type": "thinking_dropped"
} | \ No newline at end of file diff --git a/docs/models/components/anthropiciterationcachecreation.mdx b/docs/models/components/anthropiciterationcachecreation.mdx index f4af68401..7fdb64675 100644 --- a/docs/models/components/anthropiciterationcachecreation.mdx +++ b/docs/models/components/anthropiciterationcachecreation.mdx @@ -6,5 +6,5 @@ title: "AnthropicIterationCacheCreation" | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `Ephemeral1hInputTokens` | `*int64` | ➖ | N/A | -| `Ephemeral5mInputTokens` | `*int64` | ➖ | N/A | \ No newline at end of file +| `Ephemeral1hInputTokens` | `*int64` | :heavy_minus_sign: | N/A | +| `Ephemeral5mInputTokens` | `*int64` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicmessageoutputconfig.mdx b/docs/models/components/anthropicmessageoutputconfig.mdx index 25a69ab66..22e658d83 100644 --- a/docs/models/components/anthropicmessageoutputconfig.mdx +++ b/docs/models/components/anthropicmessageoutputconfig.mdx @@ -6,4 +6,4 @@ title: "AnthropicMessageOutputConfig" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.AnthropicOutputEffort](../../models/components/anthropicoutputeffort.mdx)] | ➖ | N/A | high | \ No newline at end of file +| `Effort` | optionalnullable.OptionalNullable[[components.AnthropicOutputEffort](../../models/components/anthropicoutputeffort.mdx)] | :heavy_minus_sign: | N/A | high | \ No newline at end of file diff --git a/docs/models/components/anthropicmessageusageiteration.mdx b/docs/models/components/anthropicmessageusageiteration.mdx index c7adf3e10..7def35867 100644 --- a/docs/models/components/anthropicmessageusageiteration.mdx +++ b/docs/models/components/anthropicmessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicMessageUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `CacheCreationInputTokens` | `*int64` | ➖ | N/A | | -| `CacheReadInputTokens` | `*int64` | ➖ | N/A | | -| `InputTokens` | `*int64` | ➖ | N/A | | -| `OutputTokens` | `*int64` | ➖ | N/A | | -| `Model` | `*string` | ➖ | N/A | | -| `Type` | [components.AnthropicMessageUsageIterationType](../../models/components/anthropicmessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `Model` | `*string` | :heavy_minus_sign: | N/A | | +| `Type` | [components.AnthropicMessageUsageIterationType](../../models/components/anthropicmessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicoutputtokensdetails.mdx b/docs/models/components/anthropicoutputtokensdetails.mdx index 06792e4ca..de80847b3 100644 --- a/docs/models/components/anthropicoutputtokensdetails.mdx +++ b/docs/models/components/anthropicoutputtokensdetails.mdx @@ -6,4 +6,4 @@ title: "AnthropicOutputTokensDetails" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ThinkingTokens` | `int64` | ✅ | N/A | \ No newline at end of file +| `ThinkingTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicplaintextsource.mdx b/docs/models/components/anthropicplaintextsource.mdx index ae1510610..0f8ee421e 100644 --- a/docs/models/components/anthropicplaintextsource.mdx +++ b/docs/models/components/anthropicplaintextsource.mdx @@ -6,6 +6,6 @@ title: "AnthropicPlainTextSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | ✅ | N/A | -| `MediaType` | [components.AnthropicPlainTextSourceMediaType](../../models/components/anthropicplaintextsourcemediatype.mdx) | ✅ | N/A | -| `Type` | [components.AnthropicPlainTextSourceType](../../models/components/anthropicplaintextsourcetype.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | N/A | +| `MediaType` | [components.AnthropicPlainTextSourceMediaType](../../models/components/anthropicplaintextsourcemediatype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicPlainTextSourceType](../../models/components/anthropicplaintextsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicredactedthinkingblock.mdx b/docs/models/components/anthropicredactedthinkingblock.mdx index 0d1aa5811..035853211 100644 --- a/docs/models/components/anthropicredactedthinkingblock.mdx +++ b/docs/models/components/anthropicredactedthinkingblock.mdx @@ -6,5 +6,5 @@ title: "AnthropicRedactedThinkingBlock" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicRedactedThinkingBlockType](../../models/components/anthropicredactedthinkingblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicRedactedThinkingBlockType](../../models/components/anthropicredactedthinkingblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicrefusalstopdetails.mdx b/docs/models/components/anthropicrefusalstopdetails.mdx index a7b330eed..ce99e643c 100644 --- a/docs/models/components/anthropicrefusalstopdetails.mdx +++ b/docs/models/components/anthropicrefusalstopdetails.mdx @@ -9,6 +9,6 @@ Structured information about a refusal | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Category` | [*components.AnthropicRefusalStopDetailsCategory](../../models/components/anthropicrefusalstopdetailscategory.mdx) | ✅ | N/A | -| `Explanation` | `*string` | ✅ | N/A | -| `Type` | [components.AnthropicRefusalStopDetailsType](../../models/components/anthropicrefusalstopdetailstype.mdx) | ✅ | N/A | \ No newline at end of file +| `Category` | [*components.AnthropicRefusalStopDetailsCategory](../../models/components/anthropicrefusalstopdetailscategory.mdx) | :heavy_check_mark: | N/A | +| `Explanation` | `*string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicRefusalStopDetailsType](../../models/components/anthropicrefusalstopdetailstype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicsafeguard.mdx b/docs/models/components/anthropicsafeguard.mdx index 9765226e6..71b1f6962 100644 --- a/docs/models/components/anthropicsafeguard.mdx +++ b/docs/models/components/anthropicsafeguard.mdx @@ -9,6 +9,6 @@ A server-side safeguard Anthropic evaluates alongside the completion | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `ClassifierContext` | map[string]`any` | ➖ | N/A | | -| `Type` | `string` | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file +| `ClassifierContext` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `Type` | `string` | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file diff --git a/docs/models/components/anthropicsearchresultblockparam.mdx b/docs/models/components/anthropicsearchresultblockparam.mdx index 5dd5d5076..8cfe7f426 100644 --- a/docs/models/components/anthropicsearchresultblockparam.mdx +++ b/docs/models/components/anthropicsearchresultblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicSearchResultBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Citations` | [*components.AnthropicSearchResultBlockParamCitations](../../models/components/anthropicsearchresultblockparamcitations.mdx) | ➖ | N/A | | -| `Content` | [][components.AnthropicTextBlockParam](../../models/components/anthropictextblockparam.mdx) | ✅ | N/A | | -| `Source` | `string` | ✅ | N/A | | -| `Title` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicSearchResultBlockParamType](../../models/components/anthropicsearchresultblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Citations` | [*components.AnthropicSearchResultBlockParamCitations](../../models/components/anthropicsearchresultblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | +| `Content` | [][components.AnthropicTextBlockParam](../../models/components/anthropictextblockparam.mdx) | :heavy_check_mark: | N/A | | +| `Source` | `string` | :heavy_check_mark: | N/A | | +| `Title` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicSearchResultBlockParamType](../../models/components/anthropicsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicsearchresultblockparamcitations.mdx b/docs/models/components/anthropicsearchresultblockparamcitations.mdx index 8c1f5c80c..9fa5367e2 100644 --- a/docs/models/components/anthropicsearchresultblockparamcitations.mdx +++ b/docs/models/components/anthropicsearchresultblockparamcitations.mdx @@ -6,4 +6,4 @@ title: "AnthropicSearchResultBlockParamCitations" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Enabled` | `*bool` | ➖ | N/A | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicservertoolusage.mdx b/docs/models/components/anthropicservertoolusage.mdx index be89ac940..7a7c328f8 100644 --- a/docs/models/components/anthropicservertoolusage.mdx +++ b/docs/models/components/anthropicservertoolusage.mdx @@ -6,5 +6,5 @@ title: "AnthropicServerToolUsage" | Field | Type | Required | Description | | ------------------- | ------------------- | ------------------- | ------------------- | -| `WebFetchRequests` | `int64` | ✅ | N/A | -| `WebSearchRequests` | `int64` | ✅ | N/A | \ No newline at end of file +| `WebFetchRequests` | `int64` | :heavy_check_mark: | N/A | +| `WebSearchRequests` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictextblock.mdx b/docs/models/components/anthropictextblock.mdx index 0cfb070ce..ad05e22a0 100644 --- a/docs/models/components/anthropictextblock.mdx +++ b/docs/models/components/anthropictextblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextBlock" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Citations` | [][components.AnthropicTextCitation](../../models/components/anthropictextcitation.mdx) | ✅ | N/A | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicTextBlockType](../../models/components/anthropictextblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `Citations` | [][components.AnthropicTextCitation](../../models/components/anthropictextcitation.mdx) | :heavy_check_mark: | N/A | +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicTextBlockType](../../models/components/anthropictextblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictextblockparam.mdx b/docs/models/components/anthropictextblockparam.mdx index aa581b33e..7bc465cea 100644 --- a/docs/models/components/anthropictextblockparam.mdx +++ b/docs/models/components/anthropictextblockparam.mdx @@ -6,7 +6,7 @@ title: "AnthropicTextBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Citations` | optionalnullable.OptionalNullable[[][components.Citation](../../models/components/citation.mdx)] | ➖ | N/A | | -| `Text` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicTextBlockParamType](../../models/components/anthropictextblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Citations` | optionalnullable.OptionalNullable[[][components.Citation](../../models/components/citation.mdx)] | :heavy_minus_sign: | N/A | | +| `Text` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicTextBlockParamType](../../models/components/anthropictextblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutioncreateresult.mdx b/docs/models/components/anthropictexteditorcodeexecutioncreateresult.mdx index 71b7c2af3..3e0667901 100644 --- a/docs/models/components/anthropictexteditorcodeexecutioncreateresult.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutioncreateresult.mdx @@ -6,5 +6,5 @@ title: "AnthropicTextEditorCodeExecutionCreateResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `IsFileUpdate` | `bool` | ✅ | N/A | -| `Type` | [components.AnthropicTextEditorCodeExecutionCreateResultType](../../models/components/anthropictexteditorcodeexecutioncreateresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `IsFileUpdate` | `bool` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicTextEditorCodeExecutionCreateResultType](../../models/components/anthropictexteditorcodeexecutioncreateresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx b/docs/models/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx index e712e39f4..5b07e0ae0 100644 --- a/docs/models/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx @@ -6,9 +6,9 @@ title: "AnthropicTextEditorCodeExecutionStrReplaceResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Lines` | []`string` | ✅ | N/A | -| `NewLines` | `*int64` | ✅ | N/A | -| `NewStart` | `*int64` | ✅ | N/A | -| `OldLines` | `*int64` | ✅ | N/A | -| `OldStart` | `*int64` | ✅ | N/A | -| `Type` | [components.AnthropicTextEditorCodeExecutionStrReplaceResultType](../../models/components/anthropictexteditorcodeexecutionstrreplaceresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Lines` | []`string` | :heavy_check_mark: | N/A | +| `NewLines` | `*int64` | :heavy_check_mark: | N/A | +| `NewStart` | `*int64` | :heavy_check_mark: | N/A | +| `OldLines` | `*int64` | :heavy_check_mark: | N/A | +| `OldStart` | `*int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicTextEditorCodeExecutionStrReplaceResultType](../../models/components/anthropictexteditorcodeexecutionstrreplaceresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutiontoolresult.mdx b/docs/models/components/anthropictexteditorcodeexecutiontoolresult.mdx index 1565dac1f..667cf9976 100644 --- a/docs/models/components/anthropictexteditorcodeexecutiontoolresult.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextEditorCodeExecutionToolResult" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicTextEditorCodeExecutionContent](../../models/components/anthropictexteditorcodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": "file content",
"file_type": "text",
"num_lines": 10,
"start_line": 1,
"total_lines": 10,
"type": "text_editor_code_execution_view_result"
} | -| `ToolUseID` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicTextEditorCodeExecutionToolResultType](../../models/components/anthropictexteditorcodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicTextEditorCodeExecutionContent](../../models/components/anthropictexteditorcodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": "file content",
"file_type": "text",
"num_lines": 10,
"start_line": 1,
"total_lines": 10,
"type": "text_editor_code_execution_view_result"
} | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicTextEditorCodeExecutionToolResultType](../../models/components/anthropictexteditorcodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutiontoolresulterror.mdx b/docs/models/components/anthropictexteditorcodeexecutiontoolresulterror.mdx index 1759f49f8..b0fec48eb 100644 --- a/docs/models/components/anthropictexteditorcodeexecutiontoolresulterror.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutiontoolresulterror.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextEditorCodeExecutionToolResultError" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../../models/components/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | -| `ErrorMessage` | `*string` | ✅ | N/A | -| `Type` | [components.AnthropicTextEditorCodeExecutionToolResultErrorType](../../models/components/anthropictexteditorcodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `ErrorCode` | [components.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../../models/components/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | +| `ErrorMessage` | `*string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicTextEditorCodeExecutionToolResultErrorType](../../models/components/anthropictexteditorcodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutionviewresult.mdx b/docs/models/components/anthropictexteditorcodeexecutionviewresult.mdx index 9dcbc9888..02c45a0bf 100644 --- a/docs/models/components/anthropictexteditorcodeexecutionviewresult.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutionviewresult.mdx @@ -6,9 +6,9 @@ title: "AnthropicTextEditorCodeExecutionViewResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | `string` | ✅ | N/A | -| `FileType` | [components.AnthropicTextEditorCodeExecutionViewResultFileType](../../models/components/anthropictexteditorcodeexecutionviewresultfiletype.mdx) | ✅ | N/A | -| `NumLines` | `*int64` | ✅ | N/A | -| `StartLine` | `*int64` | ✅ | N/A | -| `TotalLines` | `*int64` | ✅ | N/A | -| `Type` | [components.AnthropicTextEditorCodeExecutionViewResultType](../../models/components/anthropictexteditorcodeexecutionviewresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | `string` | :heavy_check_mark: | N/A | +| `FileType` | [components.AnthropicTextEditorCodeExecutionViewResultFileType](../../models/components/anthropictexteditorcodeexecutionviewresultfiletype.mdx) | :heavy_check_mark: | N/A | +| `NumLines` | `*int64` | :heavy_check_mark: | N/A | +| `StartLine` | `*int64` | :heavy_check_mark: | N/A | +| `TotalLines` | `*int64` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicTextEditorCodeExecutionViewResultType](../../models/components/anthropictexteditorcodeexecutionviewresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicthinkingblock.mdx b/docs/models/components/anthropicthinkingblock.mdx index 02a919310..c5dbf107e 100644 --- a/docs/models/components/anthropicthinkingblock.mdx +++ b/docs/models/components/anthropicthinkingblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicThinkingBlock" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Signature` | `string` | ✅ | N/A | -| `Thinking` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicThinkingBlockType](../../models/components/anthropicthinkingblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `Signature` | `string` | :heavy_check_mark: | N/A | +| `Thinking` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicThinkingBlockType](../../models/components/anthropicthinkingblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicthinkingblockbinding.mdx b/docs/models/components/anthropicthinkingblockbinding.mdx index f0e8a03d2..b372a70e1 100644 --- a/docs/models/components/anthropicthinkingblockbinding.mdx +++ b/docs/models/components/anthropicthinkingblockbinding.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingBlockBinding" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ~~`MismatchBehavior`~~ | optionalnullable.OptionalNullable[[components.MismatchBehavior](../../models/components/mismatchbehavior.mdx)] | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. | -| `PrefixMismatchBehavior` | optionalnullable.OptionalNullable[[components.PrefixMismatchBehavior](../../models/components/prefixmismatchbehavior.mdx)] | ➖ | N/A | \ No newline at end of file +| ~~`MismatchBehavior`~~ | optionalnullable.OptionalNullable[[components.MismatchBehavior](../../models/components/mismatchbehavior.mdx)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. | +| `PrefixMismatchBehavior` | optionalnullable.OptionalNullable[[components.PrefixMismatchBehavior](../../models/components/prefixmismatchbehavior.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicthinkingturns.mdx b/docs/models/components/anthropicthinkingturns.mdx index bc2df8200..81a629801 100644 --- a/docs/models/components/anthropicthinkingturns.mdx +++ b/docs/models/components/anthropicthinkingturns.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingTurns" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicThinkingTurnsType](../../models/components/anthropicthinkingturnstype.mdx) | ✅ | N/A | -| `Value` | `int64` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnthropicThinkingTurnsType](../../models/components/anthropicthinkingturnstype.mdx) | :heavy_check_mark: | N/A | +| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolreference.mdx b/docs/models/components/anthropictoolreference.mdx index ced1608ad..42339f5f1 100644 --- a/docs/models/components/anthropictoolreference.mdx +++ b/docs/models/components/anthropictoolreference.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ToolName` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicToolReferenceType](../../models/components/anthropictoolreferencetype.mdx) | ✅ | N/A | \ No newline at end of file +| `ToolName` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicToolReferenceType](../../models/components/anthropictoolreferencetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchresult.mdx b/docs/models/components/anthropictoolsearchresult.mdx index 665607078..83619a5fa 100644 --- a/docs/models/components/anthropictoolsearchresult.mdx +++ b/docs/models/components/anthropictoolsearchresult.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolSearchResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ToolReferences` | [][components.AnthropicToolReference](../../models/components/anthropictoolreference.mdx) | ✅ | N/A | -| `Type` | [components.AnthropicToolSearchResultType](../../models/components/anthropictoolsearchresulttype.mdx) | ✅ | N/A | \ No newline at end of file +| `ToolReferences` | [][components.AnthropicToolReference](../../models/components/anthropictoolreference.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicToolSearchResultType](../../models/components/anthropictoolsearchresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchresulterror.mdx b/docs/models/components/anthropictoolsearchresulterror.mdx index e8e41e10a..c3d0c9f5e 100644 --- a/docs/models/components/anthropictoolsearchresulterror.mdx +++ b/docs/models/components/anthropictoolsearchresulterror.mdx @@ -6,6 +6,6 @@ title: "AnthropicToolSearchResultError" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicServerToolErrorCode](../../models/components/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | -| `ErrorMessage` | `*string` | ✅ | N/A | | -| `Type` | [components.AnthropicToolSearchResultErrorType](../../models/components/anthropictoolsearchresulterrortype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ErrorCode` | [components.AnthropicServerToolErrorCode](../../models/components/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | +| `ErrorMessage` | `*string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicToolSearchResultErrorType](../../models/components/anthropictoolsearchresulterrortype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchtoolbm25.mdx b/docs/models/components/anthropictoolsearchtoolbm25.mdx index 6989bf48e..a9c53b68e 100644 --- a/docs/models/components/anthropictoolsearchtoolbm25.mdx +++ b/docs/models/components/anthropictoolsearchtoolbm25.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolBm25" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | ➖ | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `DeferLoading` | `*bool` | ➖ | N/A | | -| `Name` | [components.AnthropicToolSearchToolBm25Name](../../models/components/anthropictoolsearchtoolbm25name.mdx) | ✅ | N/A | | -| `Strict` | `*bool` | ➖ | N/A | | -| `Type` | [components.AnthropicToolSearchToolBm25Type](../../models/components/anthropictoolsearchtoolbm25type.mdx) | ✅ | N/A | | \ No newline at end of file +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | +| `Name` | [components.AnthropicToolSearchToolBm25Name](../../models/components/anthropictoolsearchtoolbm25name.mdx) | :heavy_check_mark: | N/A | | +| `Strict` | `*bool` | :heavy_minus_sign: | N/A | | +| `Type` | [components.AnthropicToolSearchToolBm25Type](../../models/components/anthropictoolsearchtoolbm25type.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchtoolregex.mdx b/docs/models/components/anthropictoolsearchtoolregex.mdx index 0fb649a00..7955aafda 100644 --- a/docs/models/components/anthropictoolsearchtoolregex.mdx +++ b/docs/models/components/anthropictoolsearchtoolregex.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolRegex" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | ➖ | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `DeferLoading` | `*bool` | ➖ | N/A | | -| `Name` | [components.AnthropicToolSearchToolRegexName](../../models/components/anthropictoolsearchtoolregexname.mdx) | ✅ | N/A | | -| `Strict` | `*bool` | ➖ | N/A | | -| `Type` | [components.AnthropicToolSearchToolRegexType](../../models/components/anthropictoolsearchtoolregextype.mdx) | ✅ | N/A | | \ No newline at end of file +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | +| `Name` | [components.AnthropicToolSearchToolRegexName](../../models/components/anthropictoolsearchtoolregexname.mdx) | :heavy_check_mark: | N/A | | +| `Strict` | `*bool` | :heavy_minus_sign: | N/A | | +| `Type` | [components.AnthropicToolSearchToolRegexType](../../models/components/anthropictoolsearchtoolregextype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchtoolresult.mdx b/docs/models/components/anthropictoolsearchtoolresult.mdx index 170917f8b..a8ff6e164 100644 --- a/docs/models/components/anthropictoolsearchtoolresult.mdx +++ b/docs/models/components/anthropictoolsearchtoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicToolSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicToolSearchContent](../../models/components/anthropictoolsearchcontent.mdx) | ✅ | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | -| `ToolUseID` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicToolSearchToolResultType](../../models/components/anthropictoolsearchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicToolSearchContent](../../models/components/anthropictoolsearchcontent.mdx) | :heavy_check_mark: | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicToolSearchToolResultType](../../models/components/anthropictoolsearchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictooluseblock.mdx b/docs/models/components/anthropictooluseblock.mdx index 9d2c4297a..2c922b09b 100644 --- a/docs/models/components/anthropictooluseblock.mdx +++ b/docs/models/components/anthropictooluseblock.mdx @@ -6,8 +6,8 @@ title: "AnthropicToolUseBlock" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | -| `ID` | `string` | ✅ | N/A | | -| `Input` | `any` | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicToolUseBlockType](../../models/components/anthropictooluseblocktype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Input` | `any` | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicToolUseBlockType](../../models/components/anthropictooluseblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictooluseskeep.mdx b/docs/models/components/anthropictooluseskeep.mdx index 6ec63c0fd..aa7dcff64 100644 --- a/docs/models/components/anthropictooluseskeep.mdx +++ b/docs/models/components/anthropictooluseskeep.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesKeep" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicToolUsesKeepType](../../models/components/anthropictooluseskeeptype.mdx) | ✅ | N/A | -| `Value` | `int64` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnthropicToolUsesKeepType](../../models/components/anthropictooluseskeeptype.mdx) | :heavy_check_mark: | N/A | +| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolusestrigger.mdx b/docs/models/components/anthropictoolusestrigger.mdx index f870871c0..5c288271f 100644 --- a/docs/models/components/anthropictoolusestrigger.mdx +++ b/docs/models/components/anthropictoolusestrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesTrigger" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicToolUsesTriggerType](../../models/components/anthropictoolusestriggertype.mdx) | ✅ | N/A | -| `Value` | `int64` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnthropicToolUsesTriggerType](../../models/components/anthropictoolusestriggertype.mdx) | :heavy_check_mark: | N/A | +| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicunknownusageiteration.mdx b/docs/models/components/anthropicunknownusageiteration.mdx index 3e42011d3..bbe04bc10 100644 --- a/docs/models/components/anthropicunknownusageiteration.mdx +++ b/docs/models/components/anthropicunknownusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicUnknownUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `CacheCreationInputTokens` | `*int64` | ➖ | N/A | | -| `CacheReadInputTokens` | `*int64` | ➖ | N/A | | -| `InputTokens` | `*int64` | ➖ | N/A | | -| `OutputTokens` | `*int64` | ➖ | N/A | | -| `Type` | `string` | ✅ | N/A | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `Type` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicurlimagesource.mdx b/docs/models/components/anthropicurlimagesource.mdx index 5730f3059..6c06a3802 100644 --- a/docs/models/components/anthropicurlimagesource.mdx +++ b/docs/models/components/anthropicurlimagesource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLImageSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Type` | [components.AnthropicURLImageSourceType](../../models/components/anthropicurlimagesourcetype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnthropicURLImageSourceType](../../models/components/anthropicurlimagesourcetype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicurlpdfsource.mdx b/docs/models/components/anthropicurlpdfsource.mdx index 5fc61ebf2..20ac41425 100644 --- a/docs/models/components/anthropicurlpdfsource.mdx +++ b/docs/models/components/anthropicurlpdfsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLPdfSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicURLPdfSourceType](../../models/components/anthropicurlpdfsourcetype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.AnthropicURLPdfSourceType](../../models/components/anthropicurlpdfsourcetype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebfetchblock.mdx b/docs/models/components/anthropicwebfetchblock.mdx index e5e7b9898..ad112c2cc 100644 --- a/docs/models/components/anthropicwebfetchblock.mdx +++ b/docs/models/components/anthropicwebfetchblock.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebFetchBlock" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicDocumentBlock](../../models/components/anthropicdocumentblock.mdx) | ✅ | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | -| `RetrievedAt` | `*string` | ✅ | N/A | | -| `Type` | [components.AnthropicWebFetchBlockType](../../models/components/anthropicwebfetchblocktype.mdx) | ✅ | N/A | | -| `URL` | `string` | ✅ | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicDocumentBlock](../../models/components/anthropicdocumentblock.mdx) | :heavy_check_mark: | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | +| `RetrievedAt` | `*string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicWebFetchBlockType](../../models/components/anthropicwebfetchblocktype.mdx) | :heavy_check_mark: | N/A | | +| `URL` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicwebfetchtoolresult.mdx b/docs/models/components/anthropicwebfetchtoolresult.mdx index b3741a480..32c8c00e3 100644 --- a/docs/models/components/anthropicwebfetchtoolresult.mdx +++ b/docs/models/components/anthropicwebfetchtoolresult.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebFetchToolResult" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | -| `Content` | [components.AnthropicWebFetchContent](../../models/components/anthropicwebfetchcontent.mdx) | ✅ | N/A | \{
"content": \{
"citations": null,
"source": \{
"data": "",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
},
"retrieved_at": null,
"type": "web_fetch_result",
"url": "https://example.com"
} | -| `ToolUseID` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicWebFetchToolResultType](../../models/components/anthropicwebfetchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | +| `Content` | [components.AnthropicWebFetchContent](../../models/components/anthropicwebfetchcontent.mdx) | :heavy_check_mark: | N/A | \{
"content": \{
"citations": null,
"source": \{
"data": "",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
},
"retrieved_at": null,
"type": "web_fetch_result",
"url": "https://example.com"
} | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicWebFetchToolResultType](../../models/components/anthropicwebfetchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicwebfetchtoolresulterror.mdx b/docs/models/components/anthropicwebfetchtoolresulterror.mdx index 043f09829..3923fcf4e 100644 --- a/docs/models/components/anthropicwebfetchtoolresulterror.mdx +++ b/docs/models/components/anthropicwebfetchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicWebFetchToolResultError" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicWebFetchToolResultErrorErrorCode](../../models/components/anthropicwebfetchtoolresulterrorerrorcode.mdx) | ✅ | N/A | -| `Type` | [components.AnthropicWebFetchToolResultErrorType](../../models/components/anthropicwebfetchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `ErrorCode` | [components.AnthropicWebFetchToolResultErrorErrorCode](../../models/components/anthropicwebfetchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicWebFetchToolResultErrorType](../../models/components/anthropicwebfetchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchresult.mdx b/docs/models/components/anthropicwebsearchresult.mdx index 0809fe1ea..c7c292031 100644 --- a/docs/models/components/anthropicwebsearchresult.mdx +++ b/docs/models/components/anthropicwebsearchresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `EncryptedContent` | `string` | ✅ | N/A | -| `PageAge` | `*string` | ✅ | N/A | -| `Title` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicWebSearchResultType](../../models/components/anthropicwebsearchresulttype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | +| `PageAge` | `*string` | :heavy_check_mark: | N/A | +| `Title` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicWebSearchResultType](../../models/components/anthropicwebsearchresulttype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchresultblockparam.mdx b/docs/models/components/anthropicwebsearchresultblockparam.mdx index e47721113..eb6574209 100644 --- a/docs/models/components/anthropicwebsearchresultblockparam.mdx +++ b/docs/models/components/anthropicwebsearchresultblockparam.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchResultBlockParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `EncryptedContent` | `string` | ✅ | N/A | -| `PageAge` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Title` | `string` | ✅ | N/A | -| `Type` | [components.AnthropicWebSearchResultBlockParamType](../../models/components/anthropicwebsearchresultblockparamtype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | +| `PageAge` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Title` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicWebSearchResultBlockParamType](../../models/components/anthropicwebsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchtoolresult.mdx b/docs/models/components/anthropicwebsearchtoolresult.mdx index 7abc9fe9b..baa262b12 100644 --- a/docs/models/components/anthropicwebsearchtoolresult.mdx +++ b/docs/models/components/anthropicwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebSearchToolResult" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | -| `Content` | [components.AnthropicWebSearchToolResultContent](../../models/components/anthropicwebsearchtoolresultcontent.mdx) | ✅ | N/A | | -| `ToolUseID` | `string` | ✅ | N/A | | -| `Type` | [components.AnthropicWebSearchToolResultType](../../models/components/anthropicwebsearchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | +| `Content` | [components.AnthropicWebSearchToolResultContent](../../models/components/anthropicwebsearchtoolresultcontent.mdx) | :heavy_check_mark: | N/A | | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicWebSearchToolResultType](../../models/components/anthropicwebsearchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchtoolresulterror.mdx b/docs/models/components/anthropicwebsearchtoolresulterror.mdx index 6f7751d9a..44eb9f000 100644 --- a/docs/models/components/anthropicwebsearchtoolresulterror.mdx +++ b/docs/models/components/anthropicwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicWebSearchToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `ErrorCode` | [components.AnthropicWebSearchToolResultErrorErrorCode](../../models/components/anthropicwebsearchtoolresulterrorerrorcode.mdx) | ✅ | N/A | -| `Type` | [components.AnthropicWebSearchToolResultErrorType](../../models/components/anthropicwebsearchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `ErrorCode` | [components.AnthropicWebSearchToolResultErrorErrorCode](../../models/components/anthropicwebsearchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicWebSearchToolResultErrorType](../../models/components/anthropicwebsearchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchtooluserlocation.mdx b/docs/models/components/anthropicwebsearchtooluserlocation.mdx index faddcecbe..d4d13b471 100644 --- a/docs/models/components/anthropicwebsearchtooluserlocation.mdx +++ b/docs/models/components/anthropicwebsearchtooluserlocation.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchToolUserLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.AnthropicWebSearchToolUserLocationType](../../models/components/anthropicwebsearchtooluserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.AnthropicWebSearchToolUserLocationType](../../models/components/anthropicwebsearchtooluserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcallitem.mdx b/docs/models/components/applypatchcallitem.mdx index 294dac6d0..e4cf696eb 100644 --- a/docs/models/components/applypatchcallitem.mdx +++ b/docs/models/components/applypatchcallitem.mdx @@ -9,8 +9,8 @@ A tool call emitted by the model requesting a V4A patch operation. The client ap | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | ✅ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `Status` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | -| `Type` | [components.ApplyPatchCallItemType](../../models/components/applypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `Status` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | +| `Type` | [components.ApplyPatchCallItemType](../../models/components/applypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx b/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx index 3f410cdab..6d90864ad 100644 --- a/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx +++ b/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx @@ -9,8 +9,8 @@ Incremental chunk of `operation.diff` for an `apply_patch_call`. Matches OpenAI' | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../../models/components/applypatchcalloperationdiffdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../../models/components/applypatchcalloperationdiffdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloperationdiffdoneevent.mdx b/docs/models/components/applypatchcalloperationdiffdoneevent.mdx index 5fc4339fd..eded2af51 100644 --- a/docs/models/components/applypatchcalloperationdiffdoneevent.mdx +++ b/docs/models/components/applypatchcalloperationdiffdoneevent.mdx @@ -9,8 +9,8 @@ Emitted when `operation.diff` streaming completes for an `apply_patch_call`. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Diff` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ApplyPatchCallOperationDiffDoneEventType](../../models/components/applypatchcalloperationdiffdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Diff` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ApplyPatchCallOperationDiffDoneEventType](../../models/components/applypatchcalloperationdiffdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloutputitem.mdx b/docs/models/components/applypatchcalloutputitem.mdx index 26912170c..e52266b81 100644 --- a/docs/models/components/applypatchcalloutputitem.mdx +++ b/docs/models/components/applypatchcalloutputitem.mdx @@ -9,8 +9,8 @@ The client's echo of an `apply_patch_call` after applying the patch. `output` is | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `CallID` | `string` | ✅ | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Output` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Status` | [components.ApplyPatchCallOutputItemStatus](../../models/components/applypatchcalloutputitemstatus.mdx) | ✅ | N/A | -| `Type` | [components.ApplyPatchCallOutputItemType](../../models/components/applypatchcalloutputitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Output` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Status` | [components.ApplyPatchCallOutputItemStatus](../../models/components/applypatchcalloutputitemstatus.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ApplyPatchCallOutputItemType](../../models/components/applypatchcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcreatefileoperation.mdx b/docs/models/components/applypatchcreatefileoperation.mdx index b14181550..031da0c12 100644 --- a/docs/models/components/applypatchcreatefileoperation.mdx +++ b/docs/models/components/applypatchcreatefileoperation.mdx @@ -9,6 +9,6 @@ The `create_file` variant of an `apply_patch_call.operation`. Carries a V4A diff | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Diff` | `string` | ✅ | N/A | -| `Path` | `string` | ✅ | N/A | -| `Type` | [components.ApplyPatchCreateFileOperationType](../../models/components/applypatchcreatefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Diff` | `string` | :heavy_check_mark: | N/A | +| `Path` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ApplyPatchCreateFileOperationType](../../models/components/applypatchcreatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchdeletefileoperation.mdx b/docs/models/components/applypatchdeletefileoperation.mdx index c6fd9c0a7..961833216 100644 --- a/docs/models/components/applypatchdeletefileoperation.mdx +++ b/docs/models/components/applypatchdeletefileoperation.mdx @@ -9,5 +9,5 @@ The `delete_file` variant of an `apply_patch_call.operation`. Identifies the fil | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Path` | `string` | ✅ | N/A | -| `Type` | [components.ApplyPatchDeleteFileOperationType](../../models/components/applypatchdeletefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Path` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ApplyPatchDeleteFileOperationType](../../models/components/applypatchdeletefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchservertool.mdx b/docs/models/components/applypatchservertool.mdx index 0cccaaf1d..7536b291a 100644 --- a/docs/models/components/applypatchservertool.mdx +++ b/docs/models/components/applypatchservertool.mdx @@ -9,4 +9,4 @@ Apply patch tool configuration | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Type` | [components.ApplyPatchServerToolType](../../models/components/applypatchservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.ApplyPatchServerToolType](../../models/components/applypatchservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchservertoolconfig.mdx b/docs/models/components/applypatchservertoolconfig.mdx index 823ea3ffe..9f223f7ff 100644 --- a/docs/models/components/applypatchservertoolconfig.mdx +++ b/docs/models/components/applypatchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:apply_patch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.ApplyPatchEngineEnum](../../models/components/applypatchengineenum.mdx) | ➖ | Which apply_patch engine to use. "auto" (default) uses native passthrough when the endpoint advertises native apply_patch support, otherwise falls back to OpenRouter's HITL validator. "native" forces native passthrough — when the endpoint does not support native, the request falls back to HITL. "openrouter" always runs the HITL validator. Native passthrough streams the diff incrementally via `apply_patch_call_operation_diff.delta` events; HITL buffers the diff for atomic delivery as a single delta. | auto | \ No newline at end of file +| `Engine` | [*components.ApplyPatchEngineEnum](../../models/components/applypatchengineenum.mdx) | :heavy_minus_sign: | Which apply_patch engine to use. "auto" (default) uses native passthrough when the endpoint advertises native apply_patch support, otherwise falls back to OpenRouter's HITL validator. "native" forces native passthrough — when the endpoint does not support native, the request falls back to HITL. "openrouter" always runs the HITL validator. Native passthrough streams the diff incrementally via `apply_patch_call_operation_diff.delta` events; HITL buffers the diff for atomic delivery as a single delta. | auto | \ No newline at end of file diff --git a/docs/models/components/applypatchservertoolopenrouter.mdx b/docs/models/components/applypatchservertoolopenrouter.mdx index 32ebb50a9..db392acd4 100644 --- a/docs/models/components/applypatchservertoolopenrouter.mdx +++ b/docs/models/components/applypatchservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: validates V4A diff patches for file operations | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ApplyPatchServerToolConfig](../../models/components/applypatchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | -| `Type` | [components.ApplyPatchServerToolOpenRouterType](../../models/components/applypatchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.ApplyPatchServerToolConfig](../../models/components/applypatchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | +| `Type` | [components.ApplyPatchServerToolOpenRouterType](../../models/components/applypatchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/applypatchupdatefileoperation.mdx b/docs/models/components/applypatchupdatefileoperation.mdx index 726fa8292..33ff6f7bb 100644 --- a/docs/models/components/applypatchupdatefileoperation.mdx +++ b/docs/models/components/applypatchupdatefileoperation.mdx @@ -9,6 +9,6 @@ The `update_file` variant of an `apply_patch_call.operation`. Carries a V4A diff | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Diff` | `string` | ✅ | N/A | -| `Path` | `string` | ✅ | N/A | -| `Type` | [components.ApplyPatchUpdateFileOperationType](../../models/components/applypatchupdatefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Diff` | `string` | :heavy_check_mark: | N/A | +| `Path` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ApplyPatchUpdateFileOperationType](../../models/components/applypatchupdatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/apprankingsitem.mdx b/docs/models/components/apprankingsitem.mdx index fb3641271..4e9d6619a 100644 --- a/docs/models/components/apprankingsitem.mdx +++ b/docs/models/components/apprankingsitem.mdx @@ -6,8 +6,8 @@ title: "AppRankingsItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AppID` | `int64` | ✅ | Stable numeric identifier of the app on OpenRouter. | 12345 | -| `AppName` | `string` | ✅ | Public display name of the app. | Cline | -| `Rank` | `int64` | ✅ | 1-based position of the app within this response, per the requested `sort`. | 1 | -| `TotalRequests` | `int64` | ✅ | Number of requests attributed to the app inside the date window. | 4321 | -| `TotalTokens` | `string` | ✅ | Sum of `prompt_tokens + completion_tokens` attributed to the app inside the date window, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file +| `AppID` | `int64` | :heavy_check_mark: | Stable numeric identifier of the app on OpenRouter. | 12345 | +| `AppName` | `string` | :heavy_check_mark: | Public display name of the app. | Cline | +| `Rank` | `int64` | :heavy_check_mark: | 1-based position of the app within this response, per the requested `sort`. | 1 | +| `TotalRequests` | `int64` | :heavy_check_mark: | Number of requests attributed to the app inside the date window. | 4321 | +| `TotalTokens` | `string` | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` attributed to the app inside the date window, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/docs/models/components/apprankingsresponse.mdx b/docs/models/components/apprankingsresponse.mdx index 3737c4dc2..bb0c7e9e9 100644 --- a/docs/models/components/apprankingsresponse.mdx +++ b/docs/models/components/apprankingsresponse.mdx @@ -6,5 +6,5 @@ title: "AppRankingsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [][components.AppRankingsItem](../../models/components/apprankingsitem.mdx) | ✅ | Apps ranked per the requested `sort`, re-numbered 1..N after category filtering. `popular` sorts by `total_tokens` descending; `trending` sorts by absolute excess token growth descending and may return fewer than `limit` rows when few apps are growing. | | -| `Meta` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | ✅ | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `Data` | [][components.AppRankingsItem](../../models/components/apprankingsitem.mdx) | :heavy_check_mark: | Apps ranked per the requested `sort`, re-numbered 1..N after category filtering. `popular` sorts by `total_tokens` descending; `trending` sorts by absolute excess token growth descending and may return fewer than `limit` rows when few apps are growing. | | +| `Meta` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/components/architecture.mdx b/docs/models/components/architecture.mdx index 2346745ca..ced20cd9f 100644 --- a/docs/models/components/architecture.mdx +++ b/docs/models/components/architecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | ✅ | Supported input modalities | | -| `InstructType` | [*components.InstructType](../../models/components/instructtype.mdx) | ✅ | Instruction format type | chatml | -| `Modality` | `*string` | ✅ | Primary modality of the model | text | -| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | ✅ | Supported output modalities | | -| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | ✅ | N/A | GPT | \ No newline at end of file +| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | :heavy_check_mark: | Supported input modalities | | +| `InstructType` | [*components.InstructType](../../models/components/instructtype.mdx) | :heavy_check_mark: | Instruction format type | chatml | +| `Modality` | `*string` | :heavy_check_mark: | Primary modality of the model | text | +| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | :heavy_check_mark: | Supported output modalities | | +| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file diff --git a/docs/models/components/audiourl.mdx b/docs/models/components/audiourl.mdx index 110aeeb30..a520320b1 100644 --- a/docs/models/components/audiourl.mdx +++ b/docs/models/components/audiourl.mdx @@ -6,4 +6,4 @@ title: "AudioURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/autobetarouterplugin.mdx b/docs/models/components/autobetarouterplugin.mdx index 5e082dee5..1ada8c6c3 100644 --- a/docs/models/components/autobetarouterplugin.mdx +++ b/docs/models/components/autobetarouterplugin.mdx @@ -6,9 +6,9 @@ title: "AutoBetaRouterPlugin" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | []`string` | ➖ | List of model patterns to filter which models the auto-beta-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | -| ~~`CostQualityTradeoff`~~ | `*int64` | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-beta-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | -| `CostTier` | [*components.AutoBetaRouterPluginCostTier](../../models/components/autobetarouterplugincosttier.mdx) | ➖ | Named cost/quality setting. For auto-beta-router, tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | -| `Enabled` | `*bool` | ➖ | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | -| `ExcludedModels` | []`string` | ➖ | List of model patterns to exclude from auto-beta-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | -| `ID` | [components.AutoBetaRouterPluginID](../../models/components/autobetarouterpluginid.mdx) | ✅ | N/A | | \ No newline at end of file +| `AllowedModels` | []`string` | :heavy_minus_sign: | List of model patterns to filter which models the auto-beta-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | +| ~~`CostQualityTradeoff`~~ | `*int64` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-beta-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | +| `CostTier` | [*components.AutoBetaRouterPluginCostTier](../../models/components/autobetarouterplugincosttier.mdx) | :heavy_minus_sign: | Named cost/quality setting. For auto-beta-router, tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | +| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | +| `ExcludedModels` | []`string` | :heavy_minus_sign: | List of model patterns to exclude from auto-beta-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | +| `ID` | [components.AutoBetaRouterPluginID](../../models/components/autobetarouterpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/autorouterplugin.mdx b/docs/models/components/autorouterplugin.mdx index c61ee00f4..b93045ba8 100644 --- a/docs/models/components/autorouterplugin.mdx +++ b/docs/models/components/autorouterplugin.mdx @@ -6,10 +6,10 @@ title: "AutoRouterPlugin" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | []`string` | ➖ | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | -| ~~`CostQualityTradeoff`~~ | `*int64` | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | -| `CostTier` | [*components.AutoRouterPluginCostTier](../../models/components/autorouterplugincosttier.mdx) | ➖ | Named cost/quality setting. Tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | -| `Enabled` | `*bool` | ➖ | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `ExcludedModels` | []`string` | ➖ | List of model patterns to exclude from auto-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | -| `ID` | [components.AutoRouterPluginID](../../models/components/autorouterpluginid.mdx) | ✅ | N/A | | -| `PinModel` | `*bool` | ➖ | When true, reuses the model from the most recent assistant message's `model` attribute for subsequent turns. Defaults to false. | false | \ No newline at end of file +| `AllowedModels` | []`string` | :heavy_minus_sign: | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | +| ~~`CostQualityTradeoff`~~ | `*int64` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | +| `CostTier` | [*components.AutoRouterPluginCostTier](../../models/components/autorouterplugincosttier.mdx) | :heavy_minus_sign: | Named cost/quality setting. Tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | +| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | +| `ExcludedModels` | []`string` | :heavy_minus_sign: | List of model patterns to exclude from auto-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | +| `ID` | [components.AutoRouterPluginID](../../models/components/autorouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `PinModel` | `*bool` | :heavy_minus_sign: | When true, reuses the model from the most recent assistant message's `model` attribute for subsequent turns. Defaults to false. | false | \ No newline at end of file diff --git a/docs/models/components/badgatewayresponseerrordata.mdx b/docs/models/components/badgatewayresponseerrordata.mdx index bba1208e9..ff8975400 100644 --- a/docs/models/components/badgatewayresponseerrordata.mdx +++ b/docs/models/components/badgatewayresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for BadGatewayResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/badrequestresponseerrordata.mdx b/docs/models/components/badrequestresponseerrordata.mdx index ea1b654d8..e9555763c 100644 --- a/docs/models/components/badrequestresponseerrordata.mdx +++ b/docs/models/components/badrequestresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for BadRequestResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/baseinputsmessage.mdx b/docs/models/components/baseinputsmessage.mdx index 963c3f0c9..66d25c30f 100644 --- a/docs/models/components/baseinputsmessage.mdx +++ b/docs/models/components/baseinputsmessage.mdx @@ -6,7 +6,7 @@ title: "BaseInputsMessage" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.BaseInputsContent2](../../models/components/baseinputscontent2.mdx) | ✅ | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.BaseInputsPhaseUnion](../../models/components/baseinputsphaseunion.mdx)] | ➖ | N/A | -| `Role` | [components.BaseInputsRoleUnion](../../models/components/baseinputsroleunion.mdx) | ✅ | N/A | -| `Type` | [*components.BaseInputsType](../../models/components/baseinputstype.mdx) | ➖ | N/A | \ No newline at end of file +| `Content` | [components.BaseInputsContent2](../../models/components/baseinputscontent2.mdx) | :heavy_check_mark: | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.BaseInputsPhaseUnion](../../models/components/baseinputsphaseunion.mdx)] | :heavy_minus_sign: | N/A | +| `Role` | [components.BaseInputsRoleUnion](../../models/components/baseinputsroleunion.mdx) | :heavy_check_mark: | N/A | +| `Type` | [*components.BaseInputsType](../../models/components/baseinputstype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/basereasoningconfig.mdx b/docs/models/components/basereasoningconfig.mdx index de3b22e7f..7c6464ad0 100644 --- a/docs/models/components/basereasoningconfig.mdx +++ b/docs/models/components/basereasoningconfig.mdx @@ -6,7 +6,7 @@ title: "BaseReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext.mdx)] | ➖ | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | -| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | ➖ | N/A | medium | -| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode.mdx)] | ➖ | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | -| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | ➖ | N/A | auto | \ No newline at end of file +| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext.mdx)] | :heavy_minus_sign: | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | +| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | :heavy_minus_sign: | N/A | medium | +| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode.mdx)] | :heavy_minus_sign: | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | +| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | :heavy_minus_sign: | N/A | auto | \ No newline at end of file diff --git a/docs/models/components/bashservertool.mdx b/docs/models/components/bashservertool.mdx index 4ae6349ee..40ea034b2 100644 --- a/docs/models/components/bashservertool.mdx +++ b/docs/models/components/bashservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: runs shell commands server-side in a sandboxed | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `Parameters` | [*components.BashServerToolConfig](../../models/components/bashservertoolconfig.mdx) | ➖ | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | -| `Type` | [components.BashServerToolType](../../models/components/bashservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.BashServerToolConfig](../../models/components/bashservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | +| `Type` | [components.BashServerToolType](../../models/components/bashservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/bashservertoolconfig.mdx b/docs/models/components/bashservertoolconfig.mdx index 6115d30d5..5ae573bc7 100644 --- a/docs/models/components/bashservertoolconfig.mdx +++ b/docs/models/components/bashservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:bash server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.BashServerToolEngine](../../models/components/bashservertoolengine.mdx) | ➖ | Which bash engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) and "native" use native passthrough, returning the tool call to your application to run client-side; OpenRouter does not execute the commands. | auto | -| `Environment` | [*components.BashServerToolEnvironment](../../models/components/bashservertoolenvironment.mdx) | ➖ | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file +| `Engine` | [*components.BashServerToolEngine](../../models/components/bashservertoolengine.mdx) | :heavy_minus_sign: | Which bash engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) and "native" use native passthrough, returning the tool call to your application to run client-side; OpenRouter does not execute the commands. | auto | +| `Environment` | [*components.BashServerToolEnvironment](../../models/components/bashservertoolenvironment.mdx) | :heavy_minus_sign: | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file diff --git a/docs/models/components/batchdeletedobject.mdx b/docs/models/components/batchdeletedobject.mdx index c953e817d..6f7e81ab3 100644 --- a/docs/models/components/batchdeletedobject.mdx +++ b/docs/models/components/batchdeletedobject.mdx @@ -9,6 +9,6 @@ Confirms a terminal batch was removed from the API and its OpenRouter-held artif | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Deletion` | [components.BatchDeletionTargets](../../models/components/batchdeletiontargets.mdx) | ✅ | OpenRouter cleanup and, when a provider was assigned, the upstream batch deletion outcome. | \{
"openrouter": "deleted",
"upstream": \{
"provider": "Anthropic",
"status": "deleted"
}
} | -| `ID` | `string` | ✅ | N/A | batch_abc123 | -| `Object` | [components.BatchDeletedObjectObject](../../models/components/batchdeletedobjectobject.mdx) | ✅ | N/A | | \ No newline at end of file +| `Deletion` | [components.BatchDeletionTargets](../../models/components/batchdeletiontargets.mdx) | :heavy_check_mark: | OpenRouter cleanup and, when a provider was assigned, the upstream batch deletion outcome. | \{
"openrouter": "deleted",
"upstream": \{
"provider": "Anthropic",
"status": "deleted"
}
} | +| `ID` | `string` | :heavy_check_mark: | N/A | batch_abc123 | +| `Object` | [components.BatchDeletedObjectObject](../../models/components/batchdeletedobjectobject.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/batchdeletiontargets.mdx b/docs/models/components/batchdeletiontargets.mdx index 3193a3e25..99916516b 100644 --- a/docs/models/components/batchdeletiontargets.mdx +++ b/docs/models/components/batchdeletiontargets.mdx @@ -9,5 +9,5 @@ OpenRouter cleanup and, when a provider was assigned, the upstream batch deletio | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `Openrouter` | [components.Openrouter](../../models/components/openrouter.mdx) | ✅ | OpenRouter-held request and result artifacts were purged. | -| `Upstream` | [*components.Upstream](../../models/components/upstream.mdx) | ➖ | The upstream batch deletion outcome; omitted when no provider was assigned. | \ No newline at end of file +| `Openrouter` | [components.Openrouter](../../models/components/openrouter.mdx) | :heavy_check_mark: | OpenRouter-held request and result artifacts were purged. | +| `Upstream` | [*components.Upstream](../../models/components/upstream.mdx) | :heavy_minus_sign: | The upstream batch deletion outcome; omitted when no provider was assigned. | \ No newline at end of file diff --git a/docs/models/components/batcherrorresponseerror.mdx b/docs/models/components/batcherrorresponseerror.mdx index 3f1dcc54a..f799f19f5 100644 --- a/docs/models/components/batcherrorresponseerror.mdx +++ b/docs/models/components/batcherrorresponseerror.mdx @@ -6,5 +6,5 @@ title: "BatchErrorResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchlistitem.mdx b/docs/models/components/batchlistitem.mdx index df01b710b..df613e1bc 100644 --- a/docs/models/components/batchlistitem.mdx +++ b/docs/models/components/batchlistitem.mdx @@ -9,15 +9,15 @@ Metadata-only batch object. `results` is always `null` in list responses. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `CompletionWindow` | [components.BatchListItemCompletionWindow](../../models/components/batchlistitemcompletionwindow.mdx) | ✅ | N/A | -| `CreatedAt` | `int64` | ✅ | N/A | -| `Endpoint` | `string` | ✅ | N/A | -| `Error` | [*components.BatchListItemError](../../models/components/batchlistitemerror.mdx) | ✅ | N/A | -| `FinalizedAt` | `*int64` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | -| `Object` | [components.BatchListItemObject](../../models/components/batchlistitemobject.mdx) | ✅ | N/A | -| `RequestCounts` | [components.BatchListItemRequestCounts](../../models/components/batchlistitemrequestcounts.mdx) | ✅ | N/A | -| `Results` | `any` | ✅ | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | -| `Status` | [components.BatchListItemStatus](../../models/components/batchlistitemstatus.mdx) | ✅ | N/A | -| `Usage` | [*components.BatchListItemUsage](../../models/components/batchlistitemusage.mdx) | ✅ | N/A | \ No newline at end of file +| `CompletionWindow` | [components.BatchListItemCompletionWindow](../../models/components/batchlistitemcompletionwindow.mdx) | :heavy_check_mark: | N/A | +| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | +| `Endpoint` | `string` | :heavy_check_mark: | N/A | +| `Error` | [*components.BatchListItemError](../../models/components/batchlistitemerror.mdx) | :heavy_check_mark: | N/A | +| `FinalizedAt` | `*int64` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `Object` | [components.BatchListItemObject](../../models/components/batchlistitemobject.mdx) | :heavy_check_mark: | N/A | +| `RequestCounts` | [components.BatchListItemRequestCounts](../../models/components/batchlistitemrequestcounts.mdx) | :heavy_check_mark: | N/A | +| `Results` | `any` | :heavy_check_mark: | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | +| `Status` | [components.BatchListItemStatus](../../models/components/batchlistitemstatus.mdx) | :heavy_check_mark: | N/A | +| `Usage` | [*components.BatchListItemUsage](../../models/components/batchlistitemusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchlistitemcompletiontokensdetails.mdx b/docs/models/components/batchlistitemcompletiontokensdetails.mdx index aba8e00d4..7c457ac86 100644 --- a/docs/models/components/batchlistitemcompletiontokensdetails.mdx +++ b/docs/models/components/batchlistitemcompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchListItemCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/batchlistitemerror.mdx b/docs/models/components/batchlistitemerror.mdx index 2cd90488a..fc3d3b73b 100644 --- a/docs/models/components/batchlistitemerror.mdx +++ b/docs/models/components/batchlistitemerror.mdx @@ -6,4 +6,4 @@ title: "BatchListItemError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Message` | `string` | ✅ | N/A | \ No newline at end of file +| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchlistitemprompttokensdetails.mdx b/docs/models/components/batchlistitemprompttokensdetails.mdx index 910bbc8b9..297e26e78 100644 --- a/docs/models/components/batchlistitemprompttokensdetails.mdx +++ b/docs/models/components/batchlistitemprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/batchlistitemrequestcounts.mdx b/docs/models/components/batchlistitemrequestcounts.mdx index 056e7857b..cb9c93774 100644 --- a/docs/models/components/batchlistitemrequestcounts.mdx +++ b/docs/models/components/batchlistitemrequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchListItemRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Completed` | `int64` | ✅ | N/A | -| `Failed` | `int64` | ✅ | N/A | -| `Total` | `int64` | ✅ | N/A | \ No newline at end of file +| `Completed` | `int64` | :heavy_check_mark: | N/A | +| `Failed` | `int64` | :heavy_check_mark: | N/A | +| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchlistitemservertooluse.mdx b/docs/models/components/batchlistitemservertooluse.mdx index 85e11ae93..adfeb45cf 100644 --- a/docs/models/components/batchlistitemservertooluse.mdx +++ b/docs/models/components/batchlistitemservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/batchlistitemusage.mdx b/docs/models/components/batchlistitemusage.mdx index 07b202b9e..a969f5482 100644 --- a/docs/models/components/batchlistitemusage.mdx +++ b/docs/models/components/batchlistitemusage.mdx @@ -6,16 +6,16 @@ title: "BatchListItemUsage" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CompletionTokens` | `int64` | ✅ | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchListItemCompletionTokensDetails](../../models/components/batchlistitemcompletiontokensdetails.mdx)] | ➖ | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchListItemPromptTokensDetails](../../models/components/batchlistitemprompttokensdetails.mdx)] | ➖ | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchListItemServerToolUse](../../models/components/batchlistitemservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | -| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchListItemCompletionTokensDetails](../../models/components/batchlistitemcompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchListItemPromptTokensDetails](../../models/components/batchlistitemprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchListItemServerToolUse](../../models/components/batchlistitemservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | +| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/batchlistresponse.mdx b/docs/models/components/batchlistresponse.mdx index 06b5c9aad..3d2b16eae 100644 --- a/docs/models/components/batchlistresponse.mdx +++ b/docs/models/components/batchlistresponse.mdx @@ -9,8 +9,8 @@ A newest-first page of metadata-only batch objects. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Data` | [][components.BatchListItem](../../models/components/batchlistitem.mdx) | ✅ | N/A | -| `FirstID` | `*string` | ✅ | N/A | -| `HasMore` | `bool` | ✅ | N/A | -| `LastID` | `*string` | ✅ | N/A | -| `Object` | [components.BatchListResponseObject](../../models/components/batchlistresponseobject.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.BatchListItem](../../models/components/batchlistitem.mdx) | :heavy_check_mark: | N/A | +| `FirstID` | `*string` | :heavy_check_mark: | N/A | +| `HasMore` | `bool` | :heavy_check_mark: | N/A | +| `LastID` | `*string` | :heavy_check_mark: | N/A | +| `Object` | [components.BatchListResponseObject](../../models/components/batchlistresponseobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobject.mdx b/docs/models/components/batchobject.mdx index be04ddc2e..35f896573 100644 --- a/docs/models/components/batchobject.mdx +++ b/docs/models/components/batchobject.mdx @@ -6,15 +6,15 @@ title: "BatchObject" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `CompletionWindow` | [components.BatchObjectCompletionWindow](../../models/components/batchobjectcompletionwindow.mdx) | ✅ | N/A | -| `CreatedAt` | `int64` | ✅ | N/A | -| `Endpoint` | `string` | ✅ | N/A | -| `Error` | [*components.BatchObjectError](../../models/components/batchobjecterror.mdx) | ✅ | N/A | -| `FinalizedAt` | `*int64` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | -| `Object` | [components.BatchObjectObjectBatch](../../models/components/batchobjectobjectbatch.mdx) | ✅ | N/A | -| `RequestCounts` | [components.BatchObjectRequestCounts](../../models/components/batchobjectrequestcounts.mdx) | ✅ | N/A | -| `Results` | [][components.Result](../../models/components/result.mdx) | ✅ | N/A | -| `Status` | [components.BatchObjectStatus](../../models/components/batchobjectstatus.mdx) | ✅ | N/A | -| `Usage` | [*components.BatchObjectUsage](../../models/components/batchobjectusage.mdx) | ✅ | N/A | \ No newline at end of file +| `CompletionWindow` | [components.BatchObjectCompletionWindow](../../models/components/batchobjectcompletionwindow.mdx) | :heavy_check_mark: | N/A | +| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | +| `Endpoint` | `string` | :heavy_check_mark: | N/A | +| `Error` | [*components.BatchObjectError](../../models/components/batchobjecterror.mdx) | :heavy_check_mark: | N/A | +| `FinalizedAt` | `*int64` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `Object` | [components.BatchObjectObjectBatch](../../models/components/batchobjectobjectbatch.mdx) | :heavy_check_mark: | N/A | +| `RequestCounts` | [components.BatchObjectRequestCounts](../../models/components/batchobjectrequestcounts.mdx) | :heavy_check_mark: | N/A | +| `Results` | [][components.Result](../../models/components/result.mdx) | :heavy_check_mark: | N/A | +| `Status` | [components.BatchObjectStatus](../../models/components/batchobjectstatus.mdx) | :heavy_check_mark: | N/A | +| `Usage` | [*components.BatchObjectUsage](../../models/components/batchobjectusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectcompletiontokensdetails.mdx b/docs/models/components/batchobjectcompletiontokensdetails.mdx index d84335cbb..66822602c 100644 --- a/docs/models/components/batchobjectcompletiontokensdetails.mdx +++ b/docs/models/components/batchobjectcompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchObjectCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/batchobjectdata.mdx b/docs/models/components/batchobjectdata.mdx index c6600f272..90cebb655 100644 --- a/docs/models/components/batchobjectdata.mdx +++ b/docs/models/components/batchobjectdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Embedding` | [components.Embedding](../../models/components/embedding.mdx) | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `Index` | `*int64` | ➖ | Index of the embedding in the input list | 0 | -| `Object` | [components.ObjectEmbedding](../../models/components/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file +| `Embedding` | [components.Embedding](../../models/components/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `Index` | `*int64` | :heavy_minus_sign: | Index of the embedding in the input list | 0 | +| `Object` | [components.ObjectEmbedding](../../models/components/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/batchobjectdebug.mdx b/docs/models/components/batchobjectdebug.mdx index 9b98cb41c..86f04615a 100644 --- a/docs/models/components/batchobjectdebug.mdx +++ b/docs/models/components/batchobjectdebug.mdx @@ -6,6 +6,6 @@ title: "BatchObjectDebug" | Field | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `EchoUpstreamBody` | map[string]`any` | ➖ | N/A | -| `Timings` | [*components.BatchObjectTimings](../../models/components/batchobjecttimings.mdx) | ➖ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `EchoUpstreamBody` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Timings` | [*components.BatchObjectTimings](../../models/components/batchobjecttimings.mdx) | :heavy_minus_sign: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjecterror.mdx b/docs/models/components/batchobjecterror.mdx index 8f4531f6e..bcb5738ff 100644 --- a/docs/models/components/batchobjecterror.mdx +++ b/docs/models/components/batchobjecterror.mdx @@ -6,4 +6,4 @@ title: "BatchObjectError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Message` | `string` | ✅ | N/A | \ No newline at end of file +| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectfile.mdx b/docs/models/components/batchobjectfile.mdx index 98f6c5a0e..2f7095eff 100644 --- a/docs/models/components/batchobjectfile.mdx +++ b/docs/models/components/batchobjectfile.mdx @@ -6,6 +6,6 @@ title: "BatchObjectFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Content` | [][components.AnnotationContentUnion](../../models/components/annotationcontentunion.mdx) | ✅ | N/A | -| `Hash` | `string` | ✅ | N/A | -| `Name` | `*string` | ➖ | N/A | \ No newline at end of file +| `Content` | [][components.AnnotationContentUnion](../../models/components/annotationcontentunion.mdx) | :heavy_check_mark: | N/A | +| `Hash` | `string` | :heavy_check_mark: | N/A | +| `Name` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectfunction.mdx b/docs/models/components/batchobjectfunction.mdx index e9317af29..c7ac99b41 100644 --- a/docs/models/components/batchobjectfunction.mdx +++ b/docs/models/components/batchobjectfunction.mdx @@ -6,5 +6,5 @@ title: "BatchObjectFunction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Arguments` | `string` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectimageurl.mdx b/docs/models/components/batchobjectimageurl.mdx index d324437e4..0d092d54e 100644 --- a/docs/models/components/batchobjectimageurl.mdx +++ b/docs/models/components/batchobjectimageurl.mdx @@ -6,4 +6,4 @@ title: "BatchObjectImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectprompttokensdetails.mdx b/docs/models/components/batchobjectprompttokensdetails.mdx index 3e485e754..07352f8e8 100644 --- a/docs/models/components/batchobjectprompttokensdetails.mdx +++ b/docs/models/components/batchobjectprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/batchobjectrequestcounts.mdx b/docs/models/components/batchobjectrequestcounts.mdx index dbeb6020b..8df8e75df 100644 --- a/docs/models/components/batchobjectrequestcounts.mdx +++ b/docs/models/components/batchobjectrequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchObjectRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Completed` | `int64` | ✅ | N/A | -| `Failed` | `int64` | ✅ | N/A | -| `Total` | `int64` | ✅ | N/A | \ No newline at end of file +| `Completed` | `int64` | :heavy_check_mark: | N/A | +| `Failed` | `int64` | :heavy_check_mark: | N/A | +| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectresponse.mdx b/docs/models/components/batchobjectresponse.mdx index 706214072..46a3abb58 100644 --- a/docs/models/components/batchobjectresponse.mdx +++ b/docs/models/components/batchobjectresponse.mdx @@ -6,6 +6,6 @@ title: "BatchObjectResponse" | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Body` | [components.Body](../../models/components/body.mdx) | ✅ | N/A | -| `RequestID` | `*string` | ✅ | N/A | -| `StatusCode` | `int64` | ✅ | N/A | \ No newline at end of file +| `Body` | [components.Body](../../models/components/body.mdx) | :heavy_check_mark: | N/A | +| `RequestID` | `*string` | :heavy_check_mark: | N/A | +| `StatusCode` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectservertooluse.mdx b/docs/models/components/batchobjectservertooluse.mdx index 4e28249d2..71ae22911 100644 --- a/docs/models/components/batchobjectservertooluse.mdx +++ b/docs/models/components/batchobjectservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/batchobjectservertoolusedetails.mdx b/docs/models/components/batchobjectservertoolusedetails.mdx index 11fa39ccc..882e48712 100644 --- a/docs/models/components/batchobjectservertoolusedetails.mdx +++ b/docs/models/components/batchobjectservertoolusedetails.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/batchobjecttimings.mdx b/docs/models/components/batchobjecttimings.mdx index 8570766fb..2b167dc68 100644 --- a/docs/models/components/batchobjecttimings.mdx +++ b/docs/models/components/batchobjecttimings.mdx @@ -6,6 +6,6 @@ title: "BatchObjectTimings" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `EpochMs` | `int64` | ✅ | N/A | -| `Event` | [components.BatchObjectEvent](../../models/components/batchobjectevent.mdx) | ✅ | N/A | -| `StartMs` | `int64` | ✅ | N/A | \ No newline at end of file +| `EpochMs` | `int64` | :heavy_check_mark: | N/A | +| `Event` | [components.BatchObjectEvent](../../models/components/batchobjectevent.mdx) | :heavy_check_mark: | N/A | +| `StartMs` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjecturlcitation.mdx b/docs/models/components/batchobjecturlcitation.mdx index 59b4af09c..f8472027f 100644 --- a/docs/models/components/batchobjecturlcitation.mdx +++ b/docs/models/components/batchobjecturlcitation.mdx @@ -6,8 +6,8 @@ title: "BatchObjectURLCitation" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Content` | `*string` | ➖ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Title` | `string` | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Content` | `*string` | :heavy_minus_sign: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Title` | `string` | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectusage.mdx b/docs/models/components/batchobjectusage.mdx index b4706bf1b..252e2493d 100644 --- a/docs/models/components/batchobjectusage.mdx +++ b/docs/models/components/batchobjectusage.mdx @@ -6,16 +6,16 @@ title: "BatchObjectUsage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CompletionTokens` | `int64` | ✅ | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchObjectCompletionTokensDetails](../../models/components/batchobjectcompletiontokensdetails.mdx)] | ➖ | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchObjectPromptTokensDetails](../../models/components/batchobjectprompttokensdetails.mdx)] | ➖ | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchObjectServerToolUse](../../models/components/batchobjectservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | -| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchObjectCompletionTokensDetails](../../models/components/batchobjectcompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchObjectPromptTokensDetails](../../models/components/batchobjectprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchObjectServerToolUse](../../models/components/batchobjectservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | +| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx b/docs/models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx index 8fb8538c9..d107c860a 100644 --- a/docs/models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx +++ b/docs/models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchPaymentRequiredResponseCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponseerror.mdx b/docs/models/components/batchpaymentrequiredresponseerror.mdx index 8b1b3c34e..644a8211a 100644 --- a/docs/models/components/batchpaymentrequiredresponseerror.mdx +++ b/docs/models/components/batchpaymentrequiredresponseerror.mdx @@ -6,5 +6,5 @@ title: "BatchPaymentRequiredResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponseprompttokensdetails.mdx b/docs/models/components/batchpaymentrequiredresponseprompttokensdetails.mdx index 9f90395b7..ba9b93fc1 100644 --- a/docs/models/components/batchpaymentrequiredresponseprompttokensdetails.mdx +++ b/docs/models/components/batchpaymentrequiredresponseprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponserequestcounts.mdx b/docs/models/components/batchpaymentrequiredresponserequestcounts.mdx index 23a84950a..a00aba618 100644 --- a/docs/models/components/batchpaymentrequiredresponserequestcounts.mdx +++ b/docs/models/components/batchpaymentrequiredresponserequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchPaymentRequiredResponseRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Completed` | `int64` | ✅ | N/A | -| `Failed` | `int64` | ✅ | N/A | -| `Total` | `int64` | ✅ | N/A | \ No newline at end of file +| `Completed` | `int64` | :heavy_check_mark: | N/A | +| `Failed` | `int64` | :heavy_check_mark: | N/A | +| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponseservertooluse.mdx b/docs/models/components/batchpaymentrequiredresponseservertooluse.mdx index 0d7075ac6..7463355f1 100644 --- a/docs/models/components/batchpaymentrequiredresponseservertooluse.mdx +++ b/docs/models/components/batchpaymentrequiredresponseservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponseusage.mdx b/docs/models/components/batchpaymentrequiredresponseusage.mdx index e73d54c5c..08fa6c498 100644 --- a/docs/models/components/batchpaymentrequiredresponseusage.mdx +++ b/docs/models/components/batchpaymentrequiredresponseusage.mdx @@ -6,16 +6,16 @@ title: "BatchPaymentRequiredResponseUsage" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CompletionTokens` | `int64` | ✅ | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponseCompletionTokensDetails](../../models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx)] | ➖ | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponsePromptTokensDetails](../../models/components/batchpaymentrequiredresponseprompttokensdetails.mdx)] | ➖ | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponseServerToolUse](../../models/components/batchpaymentrequiredresponseservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | -| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponseCompletionTokensDetails](../../models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponsePromptTokensDetails](../../models/components/batchpaymentrequiredresponseprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponseServerToolUse](../../models/components/batchpaymentrequiredresponseservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | +| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/batchproviderpreferences.mdx b/docs/models/components/batchproviderpreferences.mdx index b69a993ed..d9734d0b4 100644 --- a/docs/models/components/batchproviderpreferences.mdx +++ b/docs/models/components/batchproviderpreferences.mdx @@ -9,5 +9,5 @@ Batch provider routing preferences. Only `provider.only` and `provider.allow_fal | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `Only` | optionalnullable.OptionalNullable[[][components.BatchProviderPreferencesOnly](../../models/components/batchproviderpreferencesonly.mdx)] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | \ No newline at end of file +| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `Only` | optionalnullable.OptionalNullable[[][components.BatchProviderPreferencesOnly](../../models/components/batchproviderpreferencesonly.mdx)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | \ No newline at end of file diff --git a/docs/models/components/batchsubmitbody.mdx b/docs/models/components/batchsubmitbody.mdx index 1392ef351..0753ceb24 100644 --- a/docs/models/components/batchsubmitbody.mdx +++ b/docs/models/components/batchsubmitbody.mdx @@ -9,8 +9,8 @@ Batch submit request body. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `CompletionWindow` | [*components.BatchSubmitBodyCompletionWindow](../../models/components/batchsubmitbodycompletionwindow.mdx) | ➖ | N/A | | -| `Endpoint` | [components.Endpoint](../../models/components/endpoint.mdx) | ✅ | N/A | | -| `Model` | `string` | ✅ | N/A | | -| `Provider` | optionalnullable.OptionalNullable[[components.BatchProviderPreferences](../../models/components/batchproviderpreferences.mdx)] | ➖ | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | -| `Requests` | [][components.Request](../../models/components/request.mdx) | ✅ | N/A | | \ No newline at end of file +| `CompletionWindow` | [*components.BatchSubmitBodyCompletionWindow](../../models/components/batchsubmitbodycompletionwindow.mdx) | :heavy_minus_sign: | N/A | | +| `Endpoint` | [components.Endpoint](../../models/components/endpoint.mdx) | :heavy_check_mark: | N/A | | +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `Provider` | optionalnullable.OptionalNullable[[components.BatchProviderPreferences](../../models/components/batchproviderpreferences.mdx)] | :heavy_minus_sign: | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | +| `Requests` | [][components.Request](../../models/components/request.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/bodychatcompletion.mdx b/docs/models/components/bodychatcompletion.mdx index 20a905143..971a28926 100644 --- a/docs/models/components/bodychatcompletion.mdx +++ b/docs/models/components/bodychatcompletion.mdx @@ -6,15 +6,15 @@ title: "BodyChatCompletion" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Alignment` | [*components.Alignment](../../models/components/alignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | -| `Choices` | [][components.Choice](../../models/components/choice.mdx) | ✅ | N/A | | -| `Created` | `int64` | ✅ | N/A | | -| `Debug` | [*components.BatchObjectDebug](../../models/components/batchobjectdebug.mdx) | ➖ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Model` | `string` | ✅ | N/A | | -| `Object` | [components.BodyObjectChatCompletion](../../models/components/bodyobjectchatcompletion.mdx) | ✅ | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `Provider` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `SystemFingerprint` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Usage` | [*components.BodyUsage1](../../models/components/bodyusage1.mdx) | ➖ | N/A | | \ No newline at end of file +| `Alignment` | [*components.Alignment](../../models/components/alignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | +| `Choices` | [][components.Choice](../../models/components/choice.mdx) | :heavy_check_mark: | N/A | | +| `Created` | `int64` | :heavy_check_mark: | N/A | | +| `Debug` | [*components.BatchObjectDebug](../../models/components/batchobjectdebug.mdx) | :heavy_minus_sign: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `Object` | [components.BodyObjectChatCompletion](../../models/components/bodyobjectchatcompletion.mdx) | :heavy_check_mark: | N/A | | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `Provider` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `SystemFingerprint` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Usage` | [*components.BodyUsage1](../../models/components/bodyusage1.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/bodycompletiontokensdetails.mdx b/docs/models/components/bodycompletiontokensdetails.mdx index c8986b7e5..d7da7be75 100644 --- a/docs/models/components/bodycompletiontokensdetails.mdx +++ b/docs/models/components/bodycompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BodyCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/bodylist.mdx b/docs/models/components/bodylist.mdx index cec25daff..4f97d6766 100644 --- a/docs/models/components/bodylist.mdx +++ b/docs/models/components/bodylist.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Data` | [][components.BatchObjectData](../../models/components/batchobjectdata.mdx) | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `ID` | `*string` | ➖ | Unique identifier for the embeddings response | embd-1234567890 | -| `Model` | `string` | ✅ | The model used for embeddings | openai/text-embedding-3-small | -| `Object` | [components.BodyObjectList](../../models/components/bodyobjectlist.mdx) | ✅ | N/A | | -| `Usage` | [*components.BodyUsage3](../../models/components/bodyusage3.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `Data` | [][components.BatchObjectData](../../models/components/batchobjectdata.mdx) | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `ID` | `*string` | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | +| `Model` | `string` | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | +| `Object` | [components.BodyObjectList](../../models/components/bodyobjectlist.mdx) | :heavy_check_mark: | N/A | | +| `Usage` | [*components.BodyUsage3](../../models/components/bodyusage3.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/models/components/bodymessage.mdx b/docs/models/components/bodymessage.mdx index a59b91a48..d3294f68f 100644 --- a/docs/models/components/bodymessage.mdx +++ b/docs/models/components/bodymessage.mdx @@ -6,14 +6,14 @@ title: "BodyMessage" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Container` | [*components.AnthropicContainer](../../models/components/anthropiccontainer.mdx) | ✅ | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | -| `Content` | [][components.ORAnthropicContentBlock](../../models/components/oranthropiccontentblock.mdx) | ✅ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `InputTransformations` | optionalnullable.OptionalNullable[[][components.AnthropicInputTransformation](../../models/components/anthropicinputtransformation.mdx)] | ➖ | N/A | | -| `Model` | `string` | ✅ | N/A | | -| `Role` | [components.BatchObjectRole](../../models/components/batchobjectrole.mdx) | ✅ | N/A | | -| `StopDetails` | [*components.AnthropicRefusalStopDetails](../../models/components/anthropicrefusalstopdetails.mdx) | ✅ | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | -| `StopReason` | [*components.ORAnthropicStopReason](../../models/components/oranthropicstopreason.mdx) | ✅ | N/A | end_turn | -| `StopSequence` | `*string` | ✅ | N/A | | -| `Type` | [components.BatchObjectTypeMessage](../../models/components/batchobjecttypemessage.mdx) | ✅ | N/A | | -| `Usage` | [components.BodyUsage2](../../models/components/bodyusage2.mdx) | ✅ | N/A | \{
"cache_creation": null,
"cache_creation_input_tokens": null,
"cache_read_input_tokens": null,
"inference_geo": null,
"input_tokens": 100,
"output_tokens": 50,
"output_tokens_details": null,
"server_tool_use": null,
"service_tier": "standard"
} | \ No newline at end of file +| `Container` | [*components.AnthropicContainer](../../models/components/anthropiccontainer.mdx) | :heavy_check_mark: | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | +| `Content` | [][components.ORAnthropicContentBlock](../../models/components/oranthropiccontentblock.mdx) | :heavy_check_mark: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `InputTransformations` | optionalnullable.OptionalNullable[[][components.AnthropicInputTransformation](../../models/components/anthropicinputtransformation.mdx)] | :heavy_minus_sign: | N/A | | +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `Role` | [components.BatchObjectRole](../../models/components/batchobjectrole.mdx) | :heavy_check_mark: | N/A | | +| `StopDetails` | [*components.AnthropicRefusalStopDetails](../../models/components/anthropicrefusalstopdetails.mdx) | :heavy_check_mark: | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | +| `StopReason` | [*components.ORAnthropicStopReason](../../models/components/oranthropicstopreason.mdx) | :heavy_check_mark: | N/A | end_turn | +| `StopSequence` | `*string` | :heavy_check_mark: | N/A | | +| `Type` | [components.BatchObjectTypeMessage](../../models/components/batchobjecttypemessage.mdx) | :heavy_check_mark: | N/A | | +| `Usage` | [components.BodyUsage2](../../models/components/bodyusage2.mdx) | :heavy_check_mark: | N/A | \{
"cache_creation": null,
"cache_creation_input_tokens": null,
"cache_read_input_tokens": null,
"inference_geo": null,
"input_tokens": 100,
"output_tokens": 50,
"output_tokens_details": null,
"server_tool_use": null,
"service_tier": "standard"
} | \ No newline at end of file diff --git a/docs/models/components/bodyprompttokensdetails1.mdx b/docs/models/components/bodyprompttokensdetails1.mdx index 63b8f5031..f83c47624 100644 --- a/docs/models/components/bodyprompttokensdetails1.mdx +++ b/docs/models/components/bodyprompttokensdetails1.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/bodyprompttokensdetails2.mdx b/docs/models/components/bodyprompttokensdetails2.mdx index 645d373d9..8364544db 100644 --- a/docs/models/components/bodyprompttokensdetails2.mdx +++ b/docs/models/components/bodyprompttokensdetails2.mdx @@ -9,8 +9,8 @@ Per-modality token breakdown. Only present when the input contains 2+ modalities | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `AudioTokens` | `*int64` | ➖ | Number of audio tokens in the input | | -| `FileTokens` | `*int64` | ➖ | Number of file/document tokens in the input | | -| `ImageTokens` | `*int64` | ➖ | Number of image tokens in the input | 258 | -| `TextTokens` | `*int64` | ➖ | Number of text tokens in the input | 8 | -| `VideoTokens` | `*int64` | ➖ | Number of video tokens in the input | | \ No newline at end of file +| `AudioTokens` | `*int64` | :heavy_minus_sign: | Number of audio tokens in the input | | +| `FileTokens` | `*int64` | :heavy_minus_sign: | Number of file/document tokens in the input | | +| `ImageTokens` | `*int64` | :heavy_minus_sign: | Number of image tokens in the input | 258 | +| `TextTokens` | `*int64` | :heavy_minus_sign: | Number of text tokens in the input | 8 | +| `VideoTokens` | `*int64` | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/models/components/bodyservertooluse.mdx b/docs/models/components/bodyservertooluse.mdx index 0c0bd4b7f..81a3cc565 100644 --- a/docs/models/components/bodyservertooluse.mdx +++ b/docs/models/components/bodyservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/bodyusage1.mdx b/docs/models/components/bodyusage1.mdx index 81fa18224..865df2c49 100644 --- a/docs/models/components/bodyusage1.mdx +++ b/docs/models/components/bodyusage1.mdx @@ -6,10 +6,10 @@ title: "BodyUsage1" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CompletionTokens` | `int64` | ✅ | The tokens generated | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BodyCompletionTokensDetails](../../models/components/bodycompletiontokensdetails.mdx)] | ➖ | N/A | -| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BodyPromptTokensDetails1](../../models/components/bodyprompttokensdetails1.mdx)] | ➖ | Breakdown of tokens used in the prompt. | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BodyServerToolUse](../../models/components/bodyservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | -| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.BatchObjectServerToolUseDetails](../../models/components/batchobjectservertoolusedetails.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | -| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | \ No newline at end of file +| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BodyCompletionTokensDetails](../../models/components/bodycompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | +| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BodyPromptTokensDetails1](../../models/components/bodyprompttokensdetails1.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BodyServerToolUse](../../models/components/bodyservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | +| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.BatchObjectServerToolUseDetails](../../models/components/batchobjectservertoolusedetails.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | +| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | \ No newline at end of file diff --git a/docs/models/components/bodyusage2.mdx b/docs/models/components/bodyusage2.mdx index 80031359c..b8a163a97 100644 --- a/docs/models/components/bodyusage2.mdx +++ b/docs/models/components/bodyusage2.mdx @@ -6,14 +6,14 @@ title: "BodyUsage2" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | [*components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx) | ✅ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CacheCreationInputTokens` | `*int64` | ✅ | N/A | | -| `CacheReadInputTokens` | `*int64` | ✅ | N/A | | -| `InferenceGeo` | `*string` | ✅ | N/A | | -| `InputTokens` | `int64` | ✅ | N/A | | -| `OutputTokens` | `int64` | ✅ | N/A | | -| `OutputTokensDetails` | [*components.AnthropicOutputTokensDetails](../../models/components/anthropicoutputtokensdetails.mdx) | ✅ | N/A | \{
"thinking_tokens": 0
} | -| `ServerToolUse` | [*components.AnthropicServerToolUsage](../../models/components/anthropicservertoolusage.mdx) | ✅ | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | -| `ServiceTier` | [*components.AnthropicServiceTier](../../models/components/anthropicservicetier.mdx) | ✅ | N/A | standard | -| `Iterations` | [][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx) | ➖ | N/A | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | \ No newline at end of file +| `CacheCreation` | [*components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx) | :heavy_check_mark: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CacheCreationInputTokens` | `*int64` | :heavy_check_mark: | N/A | | +| `CacheReadInputTokens` | `*int64` | :heavy_check_mark: | N/A | | +| `InferenceGeo` | `*string` | :heavy_check_mark: | N/A | | +| `InputTokens` | `int64` | :heavy_check_mark: | N/A | | +| `OutputTokens` | `int64` | :heavy_check_mark: | N/A | | +| `OutputTokensDetails` | [*components.AnthropicOutputTokensDetails](../../models/components/anthropicoutputtokensdetails.mdx) | :heavy_check_mark: | N/A | \{
"thinking_tokens": 0
} | +| `ServerToolUse` | [*components.AnthropicServerToolUsage](../../models/components/anthropicservertoolusage.mdx) | :heavy_check_mark: | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | +| `ServiceTier` | [*components.AnthropicServiceTier](../../models/components/anthropicservicetier.mdx) | :heavy_check_mark: | N/A | standard | +| `Iterations` | [][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx) | :heavy_minus_sign: | N/A | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | \ No newline at end of file diff --git a/docs/models/components/bodyusage3.mdx b/docs/models/components/bodyusage3.mdx index 26ad5632a..07c87f802 100644 --- a/docs/models/components/bodyusage3.mdx +++ b/docs/models/components/bodyusage3.mdx @@ -9,9 +9,9 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Cost` | `*float64` | ➖ | Cost of the request in credits | 0.0001 | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `PromptTokens` | `int64` | ✅ | Number of tokens in the input | 8 | -| `PromptTokensDetails` | [*components.BodyPromptTokensDetails2](../../models/components/bodyprompttokensdetails2.mdx) | ➖ | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | -| `TotalTokens` | `int64` | ✅ | Total number of tokens used | 8 | \ No newline at end of file +| `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `PromptTokens` | `int64` | :heavy_check_mark: | Number of tokens in the input | 8 | +| `PromptTokensDetails` | [*components.BodyPromptTokensDetails2](../../models/components/bodyprompttokensdetails2.mdx) | :heavy_minus_sign: | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | +| `TotalTokens` | `int64` | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/models/components/booleancapability.mdx b/docs/models/components/booleancapability.mdx index 43e0df119..3505ed8c7 100644 --- a/docs/models/components/booleancapability.mdx +++ b/docs/models/components/booleancapability.mdx @@ -9,4 +9,4 @@ A supported-or-not flag. Present means the parameter is accepted. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.BooleanCapabilityType](../../models/components/booleancapabilitytype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.BooleanCapabilityType](../../models/components/booleancapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/bulkaddworkspacemembersrequest.mdx b/docs/models/components/bulkaddworkspacemembersrequest.mdx index b31c67d3e..095d9bcf8 100644 --- a/docs/models/components/bulkaddworkspacemembersrequest.mdx +++ b/docs/models/components/bulkaddworkspacemembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `UserIds` | []`string` | ✅ | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `UserIds` | []`string` | :heavy_check_mark: | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/components/bulkaddworkspacemembersresponse.mdx b/docs/models/components/bulkaddworkspacemembersresponse.mdx index e198a271b..a7b13193c 100644 --- a/docs/models/components/bulkaddworkspacemembersresponse.mdx +++ b/docs/models/components/bulkaddworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "BulkAddWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `AddedCount` | `int64` | ✅ | Number of workspace memberships created or updated | 2 | -| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | ✅ | List of added workspace memberships | | \ No newline at end of file +| `AddedCount` | `int64` | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | +| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file diff --git a/docs/models/components/bulkassignkeysrequest.mdx b/docs/models/components/bulkassignkeysrequest.mdx index 66acb2f5e..5d58c25e0 100644 --- a/docs/models/components/bulkassignkeysrequest.mdx +++ b/docs/models/components/bulkassignkeysrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAssignKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `KeyHashes` | []`string` | ✅ | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `KeyHashes` | []`string` | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/models/components/bulkassignkeysresponse.mdx b/docs/models/components/bulkassignkeysresponse.mdx index 37c84ffa5..09ba20be2 100644 --- a/docs/models/components/bulkassignkeysresponse.mdx +++ b/docs/models/components/bulkassignkeysresponse.mdx @@ -6,4 +6,4 @@ title: "BulkAssignKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `AssignedCount` | `int64` | ✅ | Number of keys successfully assigned | 3 | \ No newline at end of file +| `AssignedCount` | `int64` | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/docs/models/components/bulkassignmembersrequest.mdx b/docs/models/components/bulkassignmembersrequest.mdx index c9aa0041a..dcdcf66aa 100644 --- a/docs/models/components/bulkassignmembersrequest.mdx +++ b/docs/models/components/bulkassignmembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAssignMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `MemberUserIds` | []`string` | ✅ | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `MemberUserIds` | []`string` | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/components/bulkassignmembersresponse.mdx b/docs/models/components/bulkassignmembersresponse.mdx index fa3dcd9ab..84706a4af 100644 --- a/docs/models/components/bulkassignmembersresponse.mdx +++ b/docs/models/components/bulkassignmembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkAssignMembersResponse" | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `AssignedCount` | `int64` | ✅ | Number of members successfully assigned | 2 | \ No newline at end of file +| `AssignedCount` | `int64` | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/docs/models/components/bulkremoveworkspacemembersrequest.mdx b/docs/models/components/bulkremoveworkspacemembersrequest.mdx index b3ef57abc..1752a0fe3 100644 --- a/docs/models/components/bulkremoveworkspacemembersrequest.mdx +++ b/docs/models/components/bulkremoveworkspacemembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `UserIds` | []`string` | ✅ | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `UserIds` | []`string` | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/components/bulkremoveworkspacemembersresponse.mdx b/docs/models/components/bulkremoveworkspacemembersresponse.mdx index 1f6b418f3..216da1c53 100644 --- a/docs/models/components/bulkremoveworkspacemembersresponse.mdx +++ b/docs/models/components/bulkremoveworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkRemoveWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `RemovedCount` | `int64` | ✅ | Number of members removed | 2 | \ No newline at end of file +| `RemovedCount` | `int64` | :heavy_check_mark: | Number of members removed | 2 | \ No newline at end of file diff --git a/docs/models/components/bulkunassignkeysrequest.mdx b/docs/models/components/bulkunassignkeysrequest.mdx index a78d4eb28..676cdd92b 100644 --- a/docs/models/components/bulkunassignkeysrequest.mdx +++ b/docs/models/components/bulkunassignkeysrequest.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `KeyHashes` | []`string` | ✅ | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `KeyHashes` | []`string` | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/models/components/bulkunassignkeysresponse.mdx b/docs/models/components/bulkunassignkeysresponse.mdx index 5035deb2d..dee892f3e 100644 --- a/docs/models/components/bulkunassignkeysresponse.mdx +++ b/docs/models/components/bulkunassignkeysresponse.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignKeysResponse" | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `UnassignedCount` | `int64` | ✅ | Number of keys successfully unassigned | 3 | \ No newline at end of file +| `UnassignedCount` | `int64` | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/docs/models/components/bulkunassignmembersrequest.mdx b/docs/models/components/bulkunassignmembersrequest.mdx index ebe0f6899..48269d7fc 100644 --- a/docs/models/components/bulkunassignmembersrequest.mdx +++ b/docs/models/components/bulkunassignmembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `MemberUserIds` | []`string` | ✅ | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `MemberUserIds` | []`string` | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/components/bulkunassignmembersresponse.mdx b/docs/models/components/bulkunassignmembersresponse.mdx index 812034694..ae3096508 100644 --- a/docs/models/components/bulkunassignmembersresponse.mdx +++ b/docs/models/components/bulkunassignmembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignMembersResponse" | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `UnassignedCount` | `int64` | ✅ | Number of members successfully unassigned | 2 | \ No newline at end of file +| `UnassignedCount` | `int64` | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/docs/models/components/byokkey.mdx b/docs/models/components/byokkey.mdx index 1b37065b2..bf1ddc3e2 100644 --- a/docs/models/components/byokkey.mdx +++ b/docs/models/components/byokkey.mdx @@ -6,19 +6,19 @@ title: "BYOKKey" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedAPIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `AllowedModels` | []`string` | ✅ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `AllowedUserIds` | []`string` | ✅ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | -| `DeclaredRegion` | [*components.BYOKKeyDeclaredRegion](../../models/components/byokkeydeclaredregion.mdx) | ✅ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. | null | -| `DeclaredZdr` | `*bool` | ✅ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. | null | -| `Disabled` | `bool` | ✅ | Whether this credential is currently disabled. | false | -| `ID` | `string` | ✅ | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | -| `IsBYOKOnly` | `bool` | ✅ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. | false | -| `IsFallback` | `bool` | ✅ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | -| `IsRequired` | `bool` | ✅ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. | false | -| `Label` | `string` | ✅ | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | -| `Name` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | -| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `SortOrder` | `int64` | ✅ | Position within the provider — credentials are tried in ascending sort order. | 0 | -| `WorkspaceID` | `*string` | ✅ | The workspace this credential is scoped to, or `null` when it is global — usable across every workspace in the account. A `null` value does not mean the default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `AllowedAPIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `AllowedModels` | []`string` | :heavy_check_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `AllowedUserIds` | []`string` | :heavy_check_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | +| `DeclaredRegion` | [*components.BYOKKeyDeclaredRegion](../../models/components/byokkeydeclaredregion.mdx) | :heavy_check_mark: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. | null | +| `DeclaredZdr` | `*bool` | :heavy_check_mark: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. | null | +| `Disabled` | `bool` | :heavy_check_mark: | Whether this credential is currently disabled. | false | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | +| `IsBYOKOnly` | `bool` | :heavy_check_mark: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. | false | +| `IsFallback` | `bool` | :heavy_check_mark: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | +| `IsRequired` | `bool` | :heavy_check_mark: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. | false | +| `Label` | `string` | :heavy_check_mark: | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | +| `Name` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | +| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `SortOrder` | `int64` | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | +| `WorkspaceID` | `*string` | :heavy_check_mark: | The workspace this credential is scoped to, or `null` when it is global — usable across every workspace in the account. A `null` value does not mean the default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/chatassistantimages.mdx b/docs/models/components/chatassistantimages.mdx index 442401b7a..fd6c5d754 100644 --- a/docs/models/components/chatassistantimages.mdx +++ b/docs/models/components/chatassistantimages.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImages" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ChatAssistantImagesImageURL](../../models/components/chatassistantimagesimageurl.mdx) | ✅ | N/A | \ No newline at end of file +| `ImageURL` | [components.ChatAssistantImagesImageURL](../../models/components/chatassistantimagesimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatassistantimagesimageurl.mdx b/docs/models/components/chatassistantimagesimageurl.mdx index 9a6f057c8..791d7db4b 100644 --- a/docs/models/components/chatassistantimagesimageurl.mdx +++ b/docs/models/components/chatassistantimagesimageurl.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImagesImageURL" | Field | Type | Required | Description | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `URL` | `string` | ✅ | URL or base64-encoded data of the generated image | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | URL or base64-encoded data of the generated image | \ No newline at end of file diff --git a/docs/models/components/chatassistantmessage.mdx b/docs/models/components/chatassistantmessage.mdx index 236bfc5c4..d41ea38d2 100644 --- a/docs/models/components/chatassistantmessage.mdx +++ b/docs/models/components/chatassistantmessage.mdx @@ -9,13 +9,13 @@ Assistant message for requests and responses | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | ➖ | Audio output data or reference | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | -| `Content` | optionalnullable.OptionalNullable[[components.ChatAssistantMessageContent](../../models/components/chatassistantmessagecontent.mdx)] | ➖ | Assistant message content | | -| `Images` | [][components.ChatAssistantImages](../../models/components/chatassistantimages.mdx) | ➖ | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | -| `Model` | `*string` | ➖ | Model that generated this assistant message | openai/gpt-4o | -| `Name` | `*string` | ➖ | Optional name for the assistant | | -| `Reasoning` | optionalnullable.OptionalNullable[`string`] | ➖ | Reasoning output | | -| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | -| `Refusal` | optionalnullable.OptionalNullable[`string`] | ➖ | Refusal message if content was refused | | -| `Role` | [components.ChatAssistantMessageRole](../../models/components/chatassistantmessagerole.mdx) | ✅ | N/A | | -| `ToolCalls` | [][components.ChatToolCall](../../models/components/chattoolcall.mdx) | ➖ | Tool calls made by the assistant | | \ No newline at end of file +| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | :heavy_minus_sign: | Audio output data or reference | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `Content` | optionalnullable.OptionalNullable[[components.ChatAssistantMessageContent](../../models/components/chatassistantmessagecontent.mdx)] | :heavy_minus_sign: | Assistant message content | | +| `Images` | [][components.ChatAssistantImages](../../models/components/chatassistantimages.mdx) | :heavy_minus_sign: | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | +| `Model` | `*string` | :heavy_minus_sign: | Model that generated this assistant message | openai/gpt-4o | +| `Name` | `*string` | :heavy_minus_sign: | Optional name for the assistant | | +| `Reasoning` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Reasoning output | | +| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | +| `Refusal` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Refusal message if content was refused | | +| `Role` | [components.ChatAssistantMessageRole](../../models/components/chatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `ToolCalls` | [][components.ChatToolCall](../../models/components/chattoolcall.mdx) | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file diff --git a/docs/models/components/chataudiooutput.mdx b/docs/models/components/chataudiooutput.mdx index c7e45be43..944273328 100644 --- a/docs/models/components/chataudiooutput.mdx +++ b/docs/models/components/chataudiooutput.mdx @@ -9,7 +9,7 @@ Audio output data or reference | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Data` | `*string` | ➖ | Base64 encoded audio data | -| `ExpiresAt` | `*int64` | ➖ | Audio expiration timestamp | -| `ID` | `*string` | ➖ | Audio output identifier | -| `Transcript` | `*string` | ➖ | Audio transcript | \ No newline at end of file +| `Data` | `*string` | :heavy_minus_sign: | Base64 encoded audio data | +| `ExpiresAt` | `*int64` | :heavy_minus_sign: | Audio expiration timestamp | +| `ID` | `*string` | :heavy_minus_sign: | Audio output identifier | +| `Transcript` | `*string` | :heavy_minus_sign: | Audio transcript | \ No newline at end of file diff --git a/docs/models/components/chatchoice.mdx b/docs/models/components/chatchoice.mdx index 772de95ca..9c7ef7a89 100644 --- a/docs/models/components/chatchoice.mdx +++ b/docs/models/components/chatchoice.mdx @@ -9,7 +9,7 @@ Chat completion choice | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | ✅ | N/A | stop | -| `Index` | `int64` | ✅ | Choice index | 0 | -| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | ➖ | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | -| `Message` | [components.ChatAssistantMessage](../../models/components/chatassistantmessage.mdx) | ✅ | Assistant message for requests and responses | \{
"content": "What is the capital of France?",
"role": "user"
} | \ No newline at end of file +| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | +| `Index` | `int64` | :heavy_check_mark: | Choice index | 0 | +| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | +| `Message` | [components.ChatAssistantMessage](../../models/components/chatassistantmessage.mdx) | :heavy_check_mark: | Assistant message for requests and responses | \{
"content": "What is the capital of France?",
"role": "user"
} | \ No newline at end of file diff --git a/docs/models/components/chatcontentaudio.mdx b/docs/models/components/chatcontentaudio.mdx index b0b43dc7a..2b0157064 100644 --- a/docs/models/components/chatcontentaudio.mdx +++ b/docs/models/components/chatcontentaudio.mdx @@ -9,5 +9,5 @@ Audio input content part. Supported audio formats vary by provider. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.ChatContentAudioInputAudio](../../models/components/chatcontentaudioinputaudio.mdx) | ✅ | N/A | -| `Type` | [components.ChatContentAudioType](../../models/components/chatcontentaudiotype.mdx) | ✅ | N/A | \ No newline at end of file +| `InputAudio` | [components.ChatContentAudioInputAudio](../../models/components/chatcontentaudioinputaudio.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ChatContentAudioType](../../models/components/chatcontentaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentaudioinputaudio.mdx b/docs/models/components/chatcontentaudioinputaudio.mdx index 986694bac..bc976337c 100644 --- a/docs/models/components/chatcontentaudioinputaudio.mdx +++ b/docs/models/components/chatcontentaudioinputaudio.mdx @@ -6,5 +6,5 @@ title: "ChatContentAudioInputAudio" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | ✅ | Base64 encoded audio data | -| `Format` | `string` | ✅ | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | Base64 encoded audio data | +| `Format` | `string` | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file diff --git a/docs/models/components/chatcontentcachecontrol.mdx b/docs/models/components/chatcontentcachecontrol.mdx index 8e14f84d1..110129bb8 100644 --- a/docs/models/components/chatcontentcachecontrol.mdx +++ b/docs/models/components/chatcontentcachecontrol.mdx @@ -9,5 +9,5 @@ Anthropic-style cache breakpoint for the content part. Interchangeable with the | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | -| `Type` | [components.ChatContentCacheControlType](../../models/components/chatcontentcachecontroltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | +| `Type` | [components.ChatContentCacheControlType](../../models/components/chatcontentcachecontroltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatcontentfile.mdx b/docs/models/components/chatcontentfile.mdx index 208f3a5a1..49c1fcbdf 100644 --- a/docs/models/components/chatcontentfile.mdx +++ b/docs/models/components/chatcontentfile.mdx @@ -9,5 +9,5 @@ File content part for document processing | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `File` | [components.ChatContentFileFile](../../models/components/chatcontentfilefile.mdx) | ✅ | N/A | -| `Type` | [components.ChatContentFileType](../../models/components/chatcontentfiletype.mdx) | ✅ | N/A | \ No newline at end of file +| `File` | [components.ChatContentFileFile](../../models/components/chatcontentfilefile.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ChatContentFileType](../../models/components/chatcontentfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentfilefile.mdx b/docs/models/components/chatcontentfilefile.mdx index 164a096ea..2769ae67a 100644 --- a/docs/models/components/chatcontentfilefile.mdx +++ b/docs/models/components/chatcontentfilefile.mdx @@ -6,6 +6,6 @@ title: "ChatContentFileFile" | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `FileData` | `*string` | ➖ | File content as base64 data URL or URL | -| `FileID` | `*string` | ➖ | File ID for previously uploaded files | -| `Filename` | `*string` | ➖ | Original filename | \ No newline at end of file +| `FileData` | `*string` | :heavy_minus_sign: | File content as base64 data URL or URL | +| `FileID` | `*string` | :heavy_minus_sign: | File ID for previously uploaded files | +| `Filename` | `*string` | :heavy_minus_sign: | Original filename | \ No newline at end of file diff --git a/docs/models/components/chatcontentimage.mdx b/docs/models/components/chatcontentimage.mdx index d721b60bb..7978182c6 100644 --- a/docs/models/components/chatcontentimage.mdx +++ b/docs/models/components/chatcontentimage.mdx @@ -9,5 +9,5 @@ Image content part for vision models | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ChatContentImageImageURL](../../models/components/chatcontentimageimageurl.mdx) | ✅ | N/A | -| `Type` | [components.ChatContentImageType](../../models/components/chatcontentimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `ImageURL` | [components.ChatContentImageImageURL](../../models/components/chatcontentimageimageurl.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ChatContentImageType](../../models/components/chatcontentimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentimageimageurl.mdx b/docs/models/components/chatcontentimageimageurl.mdx index 734580ead..4e9eaec26 100644 --- a/docs/models/components/chatcontentimageimageurl.mdx +++ b/docs/models/components/chatcontentimageimageurl.mdx @@ -6,5 +6,5 @@ title: "ChatContentImageImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Detail` | [*components.ChatContentImageDetail](../../models/components/chatcontentimagedetail.mdx) | ➖ | Image detail level for vision models. `original` is an OpenRouter extension (not in the OpenAI Chat Completions spec) requesting true original-resolution media; it is downgraded to `high` for providers that lack an original-resolution tier. | -| `URL` | `string` | ✅ | URL of the image (data: URLs supported) | \ No newline at end of file +| `Detail` | [*components.ChatContentImageDetail](../../models/components/chatcontentimagedetail.mdx) | :heavy_minus_sign: | Image detail level for vision models. `original` is an OpenRouter extension (not in the OpenAI Chat Completions spec) requesting true original-resolution media; it is downgraded to `high` for providers that lack an original-resolution tier. | +| `URL` | `string` | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/docs/models/components/chatcontenttext.mdx b/docs/models/components/chatcontenttext.mdx index 886672ee4..923d6d42a 100644 --- a/docs/models/components/chatcontenttext.mdx +++ b/docs/models/components/chatcontenttext.mdx @@ -9,7 +9,7 @@ Text content part | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol.mdx) | ➖ | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | -| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint.mdx)] | ➖ | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | -| `Text` | `string` | ✅ | N/A | | -| `Type` | [components.ChatContentTextType](../../models/components/chatcontenttexttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol.mdx) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | +| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint.mdx)] | :heavy_minus_sign: | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | +| `Text` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.ChatContentTextType](../../models/components/chatcontenttexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatcontentvideo.mdx b/docs/models/components/chatcontentvideo.mdx index 35ba5256e..9b545f87b 100644 --- a/docs/models/components/chatcontentvideo.mdx +++ b/docs/models/components/chatcontentvideo.mdx @@ -9,5 +9,5 @@ Video input content part | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.ChatContentVideoType](../../models/components/chatcontentvideotype.mdx) | ✅ | N/A | | -| `VideoURL` | [components.ChatContentVideoInput](../../models/components/chatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `Type` | [components.ChatContentVideoType](../../models/components/chatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | +| `VideoURL` | [components.ChatContentVideoInput](../../models/components/chatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/components/chatcontentvideoinput.mdx b/docs/models/components/chatcontentvideoinput.mdx index 623c8b210..2bd6a8619 100644 --- a/docs/models/components/chatcontentvideoinput.mdx +++ b/docs/models/components/chatcontentvideoinput.mdx @@ -9,5 +9,5 @@ Video input object | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Processing` | [*components.ChatContentVideoInputProcessing](../../models/components/chatcontentvideoinputprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `URL` | `string` | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file +| `Processing` | [*components.ChatContentVideoInputProcessing](../../models/components/chatcontentvideoinputprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `URL` | `string` | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/models/components/chatdebugoptions.mdx b/docs/models/components/chatdebugoptions.mdx index d9d0aa32f..7d820388a 100644 --- a/docs/models/components/chatdebugoptions.mdx +++ b/docs/models/components/chatdebugoptions.mdx @@ -9,4 +9,4 @@ Debug options for inspecting request transformations (streaming only) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `EchoUpstreamBody` | `*bool` | ➖ | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file +| `EchoUpstreamBody` | `*bool` | :heavy_minus_sign: | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file diff --git a/docs/models/components/chatdevelopermessage.mdx b/docs/models/components/chatdevelopermessage.mdx index a602449fd..71c2c2a9d 100644 --- a/docs/models/components/chatdevelopermessage.mdx +++ b/docs/models/components/chatdevelopermessage.mdx @@ -9,7 +9,7 @@ Developer message | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ConfigurationUpdate` | optionalnullable.OptionalNullable[[components.ChatDeveloperMessageConfigurationUpdate](../../models/components/chatdevelopermessageconfigurationupdate.mdx)] | ➖ | OpenRouter extension. Same as the system message `configuration_update`: changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. | \{
"reasoning": \{
"effort": "low"
}
} | -| `Content` | [components.ChatDeveloperMessageContent](../../models/components/chatdevelopermessagecontent.mdx) | ✅ | Developer message content | This is a message from the developer. | -| `Name` | `*string` | ➖ | Optional name for the developer message | Developer | -| `Role` | [components.ChatDeveloperMessageRole](../../models/components/chatdevelopermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `ConfigurationUpdate` | optionalnullable.OptionalNullable[[components.ChatDeveloperMessageConfigurationUpdate](../../models/components/chatdevelopermessageconfigurationupdate.mdx)] | :heavy_minus_sign: | OpenRouter extension. Same as the system message `configuration_update`: changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. | \{
"reasoning": \{
"effort": "low"
}
} | +| `Content` | [components.ChatDeveloperMessageContent](../../models/components/chatdevelopermessagecontent.mdx) | :heavy_check_mark: | Developer message content | This is a message from the developer. | +| `Name` | `*string` | :heavy_minus_sign: | Optional name for the developer message | Developer | +| `Role` | [components.ChatDeveloperMessageRole](../../models/components/chatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatdevelopermessageconfigurationupdate.mdx b/docs/models/components/chatdevelopermessageconfigurationupdate.mdx index 638ae159f..ebc763776 100644 --- a/docs/models/components/chatdevelopermessageconfigurationupdate.mdx +++ b/docs/models/components/chatdevelopermessageconfigurationupdate.mdx @@ -9,4 +9,4 @@ OpenRouter extension. Same as the system message `configuration_update`: changes | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file +| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file diff --git a/docs/models/components/chatdynamicservertool.mdx b/docs/models/components/chatdynamicservertool.mdx index 29c3aa6a3..0adb257b8 100644 --- a/docs/models/components/chatdynamicservertool.mdx +++ b/docs/models/components/chatdynamicservertool.mdx @@ -9,5 +9,5 @@ Generic OpenRouter server-tool envelope. `type` names a registered server tool ( | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Parameters` | map[string]`any` | ➖ | N/A | -| `Type` | `string` | ✅ | N/A | \ No newline at end of file +| `Parameters` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Type` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatformatgrammarconfig.mdx b/docs/models/components/chatformatgrammarconfig.mdx index ad5db7863..27fd2d493 100644 --- a/docs/models/components/chatformatgrammarconfig.mdx +++ b/docs/models/components/chatformatgrammarconfig.mdx @@ -9,5 +9,5 @@ Custom grammar response format | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Grammar` | `string` | ✅ | Custom grammar for text generation | root ::= "yes" \| "no" | -| `Type` | [components.ChatFormatGrammarConfigType](../../models/components/chatformatgrammarconfigtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Grammar` | `string` | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | +| `Type` | [components.ChatFormatGrammarConfigType](../../models/components/chatformatgrammarconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatformatjsonobjectconfig.mdx b/docs/models/components/chatformatjsonobjectconfig.mdx index ade59977f..dd1a41d3d 100644 --- a/docs/models/components/chatformatjsonobjectconfig.mdx +++ b/docs/models/components/chatformatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Type` | [components.ChatFormatJSONObjectConfigType](../../models/components/chatformatjsonobjectconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatJSONObjectConfigType](../../models/components/chatformatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatformatjsonschemaconfig.mdx b/docs/models/components/chatformatjsonschemaconfig.mdx index 47f1d0b8b..269e7ca5a 100644 --- a/docs/models/components/chatformatjsonschemaconfig.mdx +++ b/docs/models/components/chatformatjsonschemaconfig.mdx @@ -9,5 +9,5 @@ JSON Schema response format for structured outputs | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `JSONSchema` | [components.ChatJSONSchemaConfig](../../models/components/chatjsonschemaconfig.mdx) | ✅ | JSON Schema configuration object | \{
"description": "A mathematical response",
"name": "math_response",
"schema": \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
},
"strict": true
} | -| `Type` | [components.ChatFormatJSONSchemaConfigType](../../models/components/chatformatjsonschemaconfigtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `JSONSchema` | [components.ChatJSONSchemaConfig](../../models/components/chatjsonschemaconfig.mdx) | :heavy_check_mark: | JSON Schema configuration object | \{
"description": "A mathematical response",
"name": "math_response",
"schema": \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
},
"strict": true
} | +| `Type` | [components.ChatFormatJSONSchemaConfigType](../../models/components/chatformatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatformatpythonconfig.mdx b/docs/models/components/chatformatpythonconfig.mdx index dab4ab7e5..5930db0a9 100644 --- a/docs/models/components/chatformatpythonconfig.mdx +++ b/docs/models/components/chatformatpythonconfig.mdx @@ -9,4 +9,4 @@ Python code response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.ChatFormatPythonConfigType](../../models/components/chatformatpythonconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatPythonConfigType](../../models/components/chatformatpythonconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatformattextconfig.mdx b/docs/models/components/chatformattextconfig.mdx index 26ddc1ccc..104071e79 100644 --- a/docs/models/components/chatformattextconfig.mdx +++ b/docs/models/components/chatformattextconfig.mdx @@ -9,4 +9,4 @@ Default text response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Type` | [components.ChatFormatTextConfigType](../../models/components/chatformattextconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatTextConfigType](../../models/components/chatformattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatfunctiontoolfunction.mdx b/docs/models/components/chatfunctiontoolfunction.mdx index 9dc7bab58..7abed15ad 100644 --- a/docs/models/components/chatfunctiontoolfunction.mdx +++ b/docs/models/components/chatfunctiontoolfunction.mdx @@ -6,6 +6,6 @@ title: "ChatFunctionToolFunction" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol.mdx) | ➖ | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | -| `Function` | [components.ChatFunctionToolFunctionFunction](../../models/components/chatfunctiontoolfunctionfunction.mdx) | ✅ | Function definition for tool calling | \{
"description": "Get the current weather for a location",
"name": "get_weather",
"parameters": \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
}
} | -| `Type` | [components.ChatFunctionToolType](../../models/components/chatfunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol.mdx) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | +| `Function` | [components.ChatFunctionToolFunctionFunction](../../models/components/chatfunctiontoolfunctionfunction.mdx) | :heavy_check_mark: | Function definition for tool calling | \{
"description": "Get the current weather for a location",
"name": "get_weather",
"parameters": \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
}
} | +| `Type` | [components.ChatFunctionToolType](../../models/components/chatfunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatfunctiontoolfunctionfunction.mdx b/docs/models/components/chatfunctiontoolfunctionfunction.mdx index 3a9010127..00f6fe123 100644 --- a/docs/models/components/chatfunctiontoolfunctionfunction.mdx +++ b/docs/models/components/chatfunctiontoolfunctionfunction.mdx @@ -9,7 +9,7 @@ Function definition for tool calling | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | `*string` | ➖ | Function description for the model | Get the current weather for a location | -| `Name` | `string` | ✅ | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | -| `Parameters` | map[string]`any` | ➖ | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | Enable strict schema adherence | false | \ No newline at end of file +| `Description` | `*string` | :heavy_minus_sign: | Function description for the model | Get the current weather for a location | +| `Name` | `string` | :heavy_check_mark: | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | +| `Parameters` | map[string]`any` | :heavy_minus_sign: | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/models/components/chatjsonschemaconfig.mdx b/docs/models/components/chatjsonschemaconfig.mdx index 01c6a35a0..c6ab0147b 100644 --- a/docs/models/components/chatjsonschemaconfig.mdx +++ b/docs/models/components/chatjsonschemaconfig.mdx @@ -9,7 +9,7 @@ JSON Schema configuration object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Description` | `*string` | ➖ | Schema description for the model | A mathematical response | -| `Name` | `string` | ✅ | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | -| `Schema` | map[string]`any` | ➖ | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | Enable strict schema adherence | false | \ No newline at end of file +| `Description` | `*string` | :heavy_minus_sign: | Schema description for the model | A mathematical response | +| `Name` | `string` | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | +| `Schema` | map[string]`any` | :heavy_minus_sign: | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/models/components/chatnamedtoolchoice.mdx b/docs/models/components/chatnamedtoolchoice.mdx index 55ba9b606..d3a4959c4 100644 --- a/docs/models/components/chatnamedtoolchoice.mdx +++ b/docs/models/components/chatnamedtoolchoice.mdx @@ -9,5 +9,5 @@ Named tool choice for specific function | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Function` | [components.ChatNamedToolChoiceFunction](../../models/components/chatnamedtoolchoicefunction.mdx) | ✅ | N/A | -| `Type` | [components.ChatNamedToolChoiceType](../../models/components/chatnamedtoolchoicetype.mdx) | ✅ | N/A | \ No newline at end of file +| `Function` | [components.ChatNamedToolChoiceFunction](../../models/components/chatnamedtoolchoicefunction.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ChatNamedToolChoiceType](../../models/components/chatnamedtoolchoicetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatnamedtoolchoicefunction.mdx b/docs/models/components/chatnamedtoolchoicefunction.mdx index f9657c9b3..2d9e7a888 100644 --- a/docs/models/components/chatnamedtoolchoicefunction.mdx +++ b/docs/models/components/chatnamedtoolchoicefunction.mdx @@ -6,4 +6,4 @@ title: "ChatNamedToolChoiceFunction" | Field | Type | Required | Description | Example | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | -| `Name` | `string` | ✅ | Function name to call | get_weather | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | Function name to call | get_weather | \ No newline at end of file diff --git a/docs/models/components/chatrequest.mdx b/docs/models/components/chatrequest.mdx index 64a3a1fe5..116042e85 100644 --- a/docs/models/components/chatrequest.mdx +++ b/docs/models/components/chatrequest.mdx @@ -9,44 +9,44 @@ Chat completion request parameters | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Debug` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | -| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | ➖ | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | -| `LogitBias` | optionalnullable.OptionalNullable[map[string]`float64`] | ➖ | Token logit bias adjustments | \{
"50256": -100
} | -| `Logprobs` | optionalnullable.OptionalNullable[`bool`] | ➖ | Return log probabilities | false | -| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum tokens in completion | 100 | -| `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `Messages` | [][components.ChatMessages](../../models/components/chatmessages.mdx) | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `Metadata` | map[string]`string` | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | -| `MinP` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum probability threshold relative to the most likely token. Tokens with probability below min_p * (probability of top token) are filtered out. Not all providers support this parameter. | 0.1 | -| `Modalities` | [][components.Modality](../../models/components/modality.mdx) | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `Model` | `*string` | ➖ | Model to use for completion | openai/gpt-4 | -| `Models` | []`string` | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `ParallelToolCalls` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enable parallel function calling during tool use. When true, the model may generate multiple tool calls in a single response. | true | -| `Plugins` | [][components.ChatRequestPlugin](../../models/components/chatrequestplugin.mdx) | ➖ | Plugins you want to enable for this request, including their settings. | | -| `Prediction` | optionalnullable.OptionalNullable[[components.Prediction](../../models/components/prediction.mdx)] | ➖ | Static predicted output content. Supported models can use this to reduce latency when much of the response is known in advance. | \{
"content": "Expected response",
"type": "content"
} | -| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | Presence penalty (-2.0 to 2.0) | 0 | -| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `Reasoning` | [*components.ChatRequestReasoning](../../models/components/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `ReasoningEffort` | optionalnullable.OptionalNullable[[components.ChatRequestReasoningEffort](../../models/components/chatrequestreasoningeffort.mdx)] | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | -| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | Penalizes tokens based on how much they have already appeared in the text. A value of 1.0 means no penalty. Values above 1.0 penalize repeated tokens more strongly. Not all providers support this parameter. | 1 | -| `ResponseFormat` | [*components.ResponseFormat](../../models/components/responseformat.mdx) | ➖ | Response format configuration | \{
"type": "json_object"
} | -| `Seed` | optionalnullable.OptionalNullable[`int64`] | ➖ | Random seed for deterministic outputs | 42 | -| `ServiceTier` | optionalnullable.OptionalNullable[[components.ChatRequestServiceTier](../../models/components/chatrequestservicetier.mdx)] | ➖ | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | auto | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `Stop` | optionalnullable.OptionalNullable[[components.Stop](../../models/components/stop.mdx)] | ➖ | Stop sequences (up to 4) | [
"\n"
] | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `Stream` | `*bool` | ➖ | Enable streaming response | false | -| `StreamOptions` | optionalnullable.OptionalNullable[[components.ChatStreamOptions](../../models/components/chatstreamoptions.mdx)] | ➖ | Streaming configuration options | \{
"include_usage": true
} | -| `Temperature` | optionalnullable.OptionalNullable[`float64`] | ➖ | Sampling temperature (0-2) | 0.7 | -| `ToolChoice` | [*components.ChatToolChoice](../../models/components/chattoolchoice.mdx) | ➖ | Tool choice configuration | auto | -| `Tools` | [][components.ChatFunctionTool](../../models/components/chatfunctiontool.mdx) | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `TopA` | optionalnullable.OptionalNullable[`float64`] | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | -| `TopK` | optionalnullable.OptionalNullable[`int64`] | ➖ | Limits the model to choose from the top K most likely tokens at each step. A value of 1 means the model will always pick the most likely next token. Not all providers support this parameter. | 40 | -| `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of top log probabilities to return (0-20) | 5 | -| `TopP` | optionalnullable.OptionalNullable[`float64`] | ➖ | Nucleus sampling parameter (0-1) | 1 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | ➖ | Per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Debug` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | +| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | +| `LogitBias` | optionalnullable.OptionalNullable[map[string]`float64`] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | +| `Logprobs` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Return log probabilities | false | +| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum tokens in completion | 100 | +| `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `Messages` | [][components.ChatMessages](../../models/components/chatmessages.mdx) | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `Metadata` | map[string]`string` | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | +| `MinP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum probability threshold relative to the most likely token. Tokens with probability below min_p * (probability of top token) are filtered out. Not all providers support this parameter. | 0.1 | +| `Modalities` | [][components.Modality](../../models/components/modality.mdx) | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `Model` | `*string` | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | +| `Models` | []`string` | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `ParallelToolCalls` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enable parallel function calling during tool use. When true, the model may generate multiple tool calls in a single response. | true | +| `Plugins` | [][components.ChatRequestPlugin](../../models/components/chatrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `Prediction` | optionalnullable.OptionalNullable[[components.Prediction](../../models/components/prediction.mdx)] | :heavy_minus_sign: | Static predicted output content. Supported models can use this to reduce latency when much of the response is known in advance. | \{
"content": "Expected response",
"type": "content"
} | +| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | +| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `Reasoning` | [*components.ChatRequestReasoning](../../models/components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `ReasoningEffort` | optionalnullable.OptionalNullable[[components.ChatRequestReasoningEffort](../../models/components/chatrequestreasoningeffort.mdx)] | :heavy_minus_sign: | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | +| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Penalizes tokens based on how much they have already appeared in the text. A value of 1.0 means no penalty. Values above 1.0 penalize repeated tokens more strongly. Not all providers support this parameter. | 1 | +| `ResponseFormat` | [*components.ResponseFormat](../../models/components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | +| `Seed` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | +| `ServiceTier` | optionalnullable.OptionalNullable[[components.ChatRequestServiceTier](../../models/components/chatrequestservicetier.mdx)] | :heavy_minus_sign: | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | auto | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `Stop` | optionalnullable.OptionalNullable[[components.Stop](../../models/components/stop.mdx)] | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `Stream` | `*bool` | :heavy_minus_sign: | Enable streaming response | false | +| `StreamOptions` | optionalnullable.OptionalNullable[[components.ChatStreamOptions](../../models/components/chatstreamoptions.mdx)] | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | +| `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | +| `ToolChoice` | [*components.ChatToolChoice](../../models/components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | +| `Tools` | [][components.ChatFunctionTool](../../models/components/chatfunctiontool.mdx) | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `TopA` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | +| `TopK` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Limits the model to choose from the top K most likely tokens at each step. A value of 1 means the model will always pick the most likely next token. Not all providers support this parameter. | 40 | +| `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | +| `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | :heavy_minus_sign: | Per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | \ No newline at end of file diff --git a/docs/models/components/chatrequestreasoning.mdx b/docs/models/components/chatrequestreasoning.mdx index 58cde929a..bd0c82b7a 100644 --- a/docs/models/components/chatrequestreasoning.mdx +++ b/docs/models/components/chatrequestreasoning.mdx @@ -9,5 +9,5 @@ Configuration options for reasoning models | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.ChatRequestEffort](../../models/components/chatrequesteffort.mdx)] | ➖ | Constrains effort on reasoning for reasoning models | medium | -| `Summary` | optionalnullable.OptionalNullable[[components.ChatReasoningSummaryVerbosityEnum](../../models/components/chatreasoningsummaryverbosityenum.mdx)] | ➖ | N/A | concise | \ No newline at end of file +| `Effort` | optionalnullable.OptionalNullable[[components.ChatRequestEffort](../../models/components/chatrequesteffort.mdx)] | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | +| `Summary` | optionalnullable.OptionalNullable[[components.ChatReasoningSummaryVerbosityEnum](../../models/components/chatreasoningsummaryverbosityenum.mdx)] | :heavy_minus_sign: | N/A | concise | \ No newline at end of file diff --git a/docs/models/components/chatresult.mdx b/docs/models/components/chatresult.mdx index d454178d3..6365d75c9 100644 --- a/docs/models/components/chatresult.mdx +++ b/docs/models/components/chatresult.mdx @@ -9,12 +9,12 @@ Chat completion response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.ChatChoice](../../models/components/chatchoice.mdx) | ✅ | List of completion choices | | -| `Created` | `int64` | ✅ | Unix timestamp of creation | 1677652288 | -| `ID` | `string` | ✅ | Unique completion identifier | chatcmpl-123 | -| `Model` | `string` | ✅ | Model used for completion | openai/gpt-4 | -| `Object` | [components.ChatResultObject](../../models/components/chatresultobject.mdx) | ✅ | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | default | -| `SystemFingerprint` | `*string` | ✅ | System fingerprint | fp_44709d6fcb | -| `Usage` | [*components.ChatUsage](../../models/components/chatusage.mdx) | ➖ | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file +| `Choices` | [][components.ChatChoice](../../models/components/chatchoice.mdx) | :heavy_check_mark: | List of completion choices | | +| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | +| `ID` | `string` | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | +| `Model` | `string` | :heavy_check_mark: | Model used for completion | openai/gpt-4 | +| `Object` | [components.ChatResultObject](../../models/components/chatresultobject.mdx) | :heavy_check_mark: | N/A | | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | +| `SystemFingerprint` | `*string` | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | +| `Usage` | [*components.ChatUsage](../../models/components/chatusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file diff --git a/docs/models/components/chatsearchmodelsservertool.mdx b/docs/models/components/chatsearchmodelsservertool.mdx index 38b554934..55ce5ec93 100644 --- a/docs/models/components/chatsearchmodelsservertool.mdx +++ b/docs/models/components/chatsearchmodelsservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.ChatSearchModelsServerToolType](../../models/components/chatsearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.ChatSearchModelsServerToolType](../../models/components/chatsearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatservertoolchoice.mdx b/docs/models/components/chatservertoolchoice.mdx index 977d0ea33..b75d04c8b 100644 --- a/docs/models/components/chatservertoolchoice.mdx +++ b/docs/models/components/chatservertoolchoice.mdx @@ -9,4 +9,4 @@ OpenRouter extension: force a specific server tool by naming it directly in `too | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Type` | `string` | ✅ | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file +| `Type` | `string` | :heavy_check_mark: | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file diff --git a/docs/models/components/chatstreamchoice.mdx b/docs/models/components/chatstreamchoice.mdx index 6b53ace15..ace80d155 100644 --- a/docs/models/components/chatstreamchoice.mdx +++ b/docs/models/components/chatstreamchoice.mdx @@ -9,7 +9,7 @@ Streaming completion choice chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Delta` | [components.ChatStreamDelta](../../models/components/chatstreamdelta.mdx) | ✅ | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | -| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | ✅ | N/A | stop | -| `Index` | `int64` | ✅ | Choice index | 0 | -| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | ➖ | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | \ No newline at end of file +| `Delta` | [components.ChatStreamDelta](../../models/components/chatstreamdelta.mdx) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | +| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | +| `Index` | `int64` | :heavy_check_mark: | Choice index | 0 | +| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | \ No newline at end of file diff --git a/docs/models/components/chatstreamchunk.mdx b/docs/models/components/chatstreamchunk.mdx index 1c5362225..2ac55c5cb 100644 --- a/docs/models/components/chatstreamchunk.mdx +++ b/docs/models/components/chatstreamchunk.mdx @@ -9,13 +9,13 @@ Streaming chat completion chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.ChatStreamChoice](../../models/components/chatstreamchoice.mdx) | ✅ | List of streaming chunk choices | | -| `Created` | `int64` | ✅ | Unix timestamp of creation | 1677652288 | -| `Error` | [*components.ChatStreamChunkError](../../models/components/chatstreamchunkerror.mdx) | ➖ | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | -| `ID` | `string` | ✅ | Unique chunk identifier | chatcmpl-123 | -| `Model` | `string` | ✅ | Model used for completion | openai/gpt-4 | -| `Object` | [components.ChatStreamChunkObject](../../models/components/chatstreamchunkobject.mdx) | ✅ | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | default | -| `SystemFingerprint` | `*string` | ➖ | System fingerprint | fp_44709d6fcb | -| `Usage` | [*components.ChatUsage](../../models/components/chatusage.mdx) | ➖ | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file +| `Choices` | [][components.ChatStreamChoice](../../models/components/chatstreamchoice.mdx) | :heavy_check_mark: | List of streaming chunk choices | | +| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | +| `Error` | [*components.ChatStreamChunkError](../../models/components/chatstreamchunkerror.mdx) | :heavy_minus_sign: | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | +| `ID` | `string` | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | +| `Model` | `string` | :heavy_check_mark: | Model used for completion | openai/gpt-4 | +| `Object` | [components.ChatStreamChunkObject](../../models/components/chatstreamchunkobject.mdx) | :heavy_check_mark: | N/A | | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | +| `SystemFingerprint` | `*string` | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | +| `Usage` | [*components.ChatUsage](../../models/components/chatusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file diff --git a/docs/models/components/chatstreamchunkerror.mdx b/docs/models/components/chatstreamchunkerror.mdx index a6319b92c..b5d7abc14 100644 --- a/docs/models/components/chatstreamchunkerror.mdx +++ b/docs/models/components/chatstreamchunkerror.mdx @@ -9,6 +9,6 @@ Error information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `Code` | `int` | ✅ | Error code | 429 | -| `Message` | `string` | ✅ | Error message | Rate limit exceeded | -| `Metadata` | [*components.ChatStreamChunkMetadata](../../models/components/chatstreamchunkmetadata.mdx) | ➖ | Structured error metadata | | \ No newline at end of file +| `Code` | `int` | :heavy_check_mark: | Error code | 429 | +| `Message` | `string` | :heavy_check_mark: | Error message | Rate limit exceeded | +| `Metadata` | [*components.ChatStreamChunkMetadata](../../models/components/chatstreamchunkmetadata.mdx) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file diff --git a/docs/models/components/chatstreamchunkmetadata.mdx b/docs/models/components/chatstreamchunkmetadata.mdx index b67840432..249b702b3 100644 --- a/docs/models/components/chatstreamchunkmetadata.mdx +++ b/docs/models/components/chatstreamchunkmetadata.mdx @@ -9,5 +9,5 @@ Structured error metadata | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ErrorType` | [components.APIErrorType](../../models/components/apierrortype.mdx) | ✅ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `ProviderCode` | `*string` | ➖ | Upstream provider-specific error code, when available | | \ No newline at end of file +| `ErrorType` | [components.APIErrorType](../../models/components/apierrortype.mdx) | :heavy_check_mark: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `ProviderCode` | `*string` | :heavy_minus_sign: | Upstream provider-specific error code, when available | | \ No newline at end of file diff --git a/docs/models/components/chatstreamdelta.mdx b/docs/models/components/chatstreamdelta.mdx index 722d01483..e09e1eec9 100644 --- a/docs/models/components/chatstreamdelta.mdx +++ b/docs/models/components/chatstreamdelta.mdx @@ -9,10 +9,10 @@ Delta changes in streaming response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | ➖ | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | -| `Content` | optionalnullable.OptionalNullable[`string`] | ➖ | Message content delta | Hello | -| `Reasoning` | optionalnullable.OptionalNullable[`string`] | ➖ | Reasoning content delta | I need to | -| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | -| `Refusal` | optionalnullable.OptionalNullable[`string`] | ➖ | Refusal message delta | null | -| `Role` | [*components.ChatStreamDeltaRole](../../models/components/chatstreamdeltarole.mdx) | ➖ | The role of the message author | assistant | -| `ToolCalls` | [][components.ChatStreamToolCall](../../models/components/chatstreamtoolcall.mdx) | ➖ | Tool calls delta | | \ No newline at end of file +| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | :heavy_minus_sign: | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `Content` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Message content delta | Hello | +| `Reasoning` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Reasoning content delta | I need to | +| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | +| `Refusal` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Refusal message delta | null | +| `Role` | [*components.ChatStreamDeltaRole](../../models/components/chatstreamdeltarole.mdx) | :heavy_minus_sign: | The role of the message author | assistant | +| `ToolCalls` | [][components.ChatStreamToolCall](../../models/components/chatstreamtoolcall.mdx) | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file diff --git a/docs/models/components/chatstreamingresponse.mdx b/docs/models/components/chatstreamingresponse.mdx index f65ce6974..fffbbb270 100644 --- a/docs/models/components/chatstreamingresponse.mdx +++ b/docs/models/components/chatstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ChatStreamingResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ChatStreamChunk](../../models/components/chatstreamchunk.mdx) | ✅ | Streaming chat completion chunk | \{
"choices": [
\{
"delta": \{
"content": "Hello",
"role": "assistant"
},
"finish_reason": null,
"index": 0
}
],
"created": 1677652288,
"id": "chatcmpl-123",
"model": "openai/gpt-4",
"object": "chat.completion.chunk"
} | \ No newline at end of file +| `Data` | [components.ChatStreamChunk](../../models/components/chatstreamchunk.mdx) | :heavy_check_mark: | Streaming chat completion chunk | \{
"choices": [
\{
"delta": \{
"content": "Hello",
"role": "assistant"
},
"finish_reason": null,
"index": 0
}
],
"created": 1677652288,
"id": "chatcmpl-123",
"model": "openai/gpt-4",
"object": "chat.completion.chunk"
} | \ No newline at end of file diff --git a/docs/models/components/chatstreamoptions.mdx b/docs/models/components/chatstreamoptions.mdx index ebce1f51e..186c02d0c 100644 --- a/docs/models/components/chatstreamoptions.mdx +++ b/docs/models/components/chatstreamoptions.mdx @@ -9,4 +9,4 @@ Streaming configuration options | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ~~`IncludeUsage`~~ | `*bool` | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file +| ~~`IncludeUsage`~~ | `*bool` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file diff --git a/docs/models/components/chatstreamtoolcall.mdx b/docs/models/components/chatstreamtoolcall.mdx index 25a05887d..6f5e9e459 100644 --- a/docs/models/components/chatstreamtoolcall.mdx +++ b/docs/models/components/chatstreamtoolcall.mdx @@ -9,7 +9,7 @@ Tool call delta for streaming responses | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Function` | [*components.ChatStreamToolCallFunction](../../models/components/chatstreamtoolcallfunction.mdx) | ➖ | Function call details | | -| `ID` | `*string` | ➖ | Tool call identifier | call_abc123 | -| `Index` | `int64` | ✅ | Tool call index in the array | 0 | -| `Type` | [*components.ChatStreamToolCallType](../../models/components/chatstreamtoolcalltype.mdx) | ➖ | Tool call type | function | \ No newline at end of file +| `Function` | [*components.ChatStreamToolCallFunction](../../models/components/chatstreamtoolcallfunction.mdx) | :heavy_minus_sign: | Function call details | | +| `ID` | `*string` | :heavy_minus_sign: | Tool call identifier | call_abc123 | +| `Index` | `int64` | :heavy_check_mark: | Tool call index in the array | 0 | +| `Type` | [*components.ChatStreamToolCallType](../../models/components/chatstreamtoolcalltype.mdx) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file diff --git a/docs/models/components/chatstreamtoolcallfunction.mdx b/docs/models/components/chatstreamtoolcallfunction.mdx index eacf9a285..c1d33edba 100644 --- a/docs/models/components/chatstreamtoolcallfunction.mdx +++ b/docs/models/components/chatstreamtoolcallfunction.mdx @@ -9,5 +9,5 @@ Function call details | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `Arguments` | `*string` | ➖ | Function arguments as JSON string | \{"location": "..."} | -| `Name` | `*string` | ➖ | Function name | get_weather | \ No newline at end of file +| `Arguments` | `*string` | :heavy_minus_sign: | Function arguments as JSON string | \{"location": "..."} | +| `Name` | `*string` | :heavy_minus_sign: | Function name | get_weather | \ No newline at end of file diff --git a/docs/models/components/chatsystemmessage.mdx b/docs/models/components/chatsystemmessage.mdx index fc560d3a1..376954a3b 100644 --- a/docs/models/components/chatsystemmessage.mdx +++ b/docs/models/components/chatsystemmessage.mdx @@ -9,7 +9,7 @@ System message for setting behavior | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ConfigurationUpdate` | optionalnullable.OptionalNullable[[components.ChatSystemMessageConfigurationUpdate](../../models/components/chatsystemmessageconfigurationupdate.mdx)] | ➖ | OpenRouter extension. Changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. Place it on a content-less system message (`content: ""`) directly before the user message it should apply to, and keep it at that position in later requests. Equivalent to the OpenAI Responses `configuration_update` input item and the Anthropic Messages per-message `output_config.effort`. | \{
"reasoning": \{
"effort": "low"
}
} | -| `Content` | [components.ChatSystemMessageContent](../../models/components/chatsystemmessagecontent.mdx) | ✅ | System message content | You are a helpful assistant. | -| `Name` | `*string` | ➖ | Optional name for the system message | Assistant Config | -| `Role` | [components.ChatSystemMessageRole](../../models/components/chatsystemmessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `ConfigurationUpdate` | optionalnullable.OptionalNullable[[components.ChatSystemMessageConfigurationUpdate](../../models/components/chatsystemmessageconfigurationupdate.mdx)] | :heavy_minus_sign: | OpenRouter extension. Changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. Place it on a content-less system message (`content: ""`) directly before the user message it should apply to, and keep it at that position in later requests. Equivalent to the OpenAI Responses `configuration_update` input item and the Anthropic Messages per-message `output_config.effort`. | \{
"reasoning": \{
"effort": "low"
}
} | +| `Content` | [components.ChatSystemMessageContent](../../models/components/chatsystemmessagecontent.mdx) | :heavy_check_mark: | System message content | You are a helpful assistant. | +| `Name` | `*string` | :heavy_minus_sign: | Optional name for the system message | Assistant Config | +| `Role` | [components.ChatSystemMessageRole](../../models/components/chatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatsystemmessageconfigurationupdate.mdx b/docs/models/components/chatsystemmessageconfigurationupdate.mdx index b9d3c69c1..32d6713ff 100644 --- a/docs/models/components/chatsystemmessageconfigurationupdate.mdx +++ b/docs/models/components/chatsystemmessageconfigurationupdate.mdx @@ -9,4 +9,4 @@ OpenRouter extension. Changes reasoning effort from this point in the conversati | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file +| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file diff --git a/docs/models/components/chattokenlogprob.mdx b/docs/models/components/chattokenlogprob.mdx index 247da450e..b1543a482 100644 --- a/docs/models/components/chattokenlogprob.mdx +++ b/docs/models/components/chattokenlogprob.mdx @@ -9,7 +9,7 @@ Token log probability information | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | ✅ | UTF-8 bytes of the token | -| `Logprob` | `float64` | ✅ | Log probability of the token | -| `Token` | `string` | ✅ | The token | -| `TopLogprobs` | [][components.ChatTokenLogprobTopLogprob](../../models/components/chattokenlogprobtoplogprob.mdx) | ✅ | Top alternative tokens with probabilities | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_check_mark: | UTF-8 bytes of the token | +| `Logprob` | `float64` | :heavy_check_mark: | Log probability of the token | +| `Token` | `string` | :heavy_check_mark: | The token | +| `TopLogprobs` | [][components.ChatTokenLogprobTopLogprob](../../models/components/chattokenlogprobtoplogprob.mdx) | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/docs/models/components/chattokenlogprobs.mdx b/docs/models/components/chattokenlogprobs.mdx index 8b95880dd..067f0fcdf 100644 --- a/docs/models/components/chattokenlogprobs.mdx +++ b/docs/models/components/chattokenlogprobs.mdx @@ -9,5 +9,5 @@ Log probabilities for the completion | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx) | ✅ | Log probabilities for content tokens | -| `Refusal` | optionalnullable.OptionalNullable[[][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx)] | ➖ | Log probabilities for refusal tokens | \ No newline at end of file +| `Content` | [][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx) | :heavy_check_mark: | Log probabilities for content tokens | +| `Refusal` | optionalnullable.OptionalNullable[[][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx)] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/docs/models/components/chattokenlogprobtoplogprob.mdx b/docs/models/components/chattokenlogprobtoplogprob.mdx index 79e3e4198..a7c9c4b81 100644 --- a/docs/models/components/chattokenlogprobtoplogprob.mdx +++ b/docs/models/components/chattokenlogprobtoplogprob.mdx @@ -6,6 +6,6 @@ title: "ChatTokenLogprobTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | ✅ | N/A | -| `Logprob` | `float64` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_check_mark: | N/A | +| `Logprob` | `float64` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chattoolcall.mdx b/docs/models/components/chattoolcall.mdx index 607124b9f..61d059663 100644 --- a/docs/models/components/chattoolcall.mdx +++ b/docs/models/components/chattoolcall.mdx @@ -9,6 +9,6 @@ Tool call made by the assistant | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Function` | [components.ChatToolCallFunction](../../models/components/chattoolcallfunction.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | Tool call identifier | -| `Type` | [components.ChatToolCallType](../../models/components/chattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file +| `Function` | [components.ChatToolCallFunction](../../models/components/chattoolcallfunction.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | Tool call identifier | +| `Type` | [components.ChatToolCallType](../../models/components/chattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chattoolcallfunction.mdx b/docs/models/components/chattoolcallfunction.mdx index 2314523ed..908931f3b 100644 --- a/docs/models/components/chattoolcallfunction.mdx +++ b/docs/models/components/chattoolcallfunction.mdx @@ -6,5 +6,5 @@ title: "ChatToolCallFunction" | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `Arguments` | `string` | ✅ | Function arguments as JSON string | -| `Name` | `string` | ✅ | Function name to call | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | Function arguments as JSON string | +| `Name` | `string` | :heavy_check_mark: | Function name to call | \ No newline at end of file diff --git a/docs/models/components/chattoolmessage.mdx b/docs/models/components/chattoolmessage.mdx index 8375711db..894285e3b 100644 --- a/docs/models/components/chattoolmessage.mdx +++ b/docs/models/components/chattoolmessage.mdx @@ -9,6 +9,6 @@ Tool response message | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Content` | [components.ChatToolMessageContent](../../models/components/chattoolmessagecontent.mdx) | ✅ | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `Role` | [components.ChatToolMessageRole](../../models/components/chattoolmessagerole.mdx) | ✅ | N/A | | -| `ToolCallID` | `string` | ✅ | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file +| `Content` | [components.ChatToolMessageContent](../../models/components/chattoolmessagecontent.mdx) | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | +| `Role` | [components.ChatToolMessageRole](../../models/components/chattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `ToolCallID` | `string` | :heavy_check_mark: | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file diff --git a/docs/models/components/chatusage.mdx b/docs/models/components/chatusage.mdx index 6331c2b91..691f7b23d 100644 --- a/docs/models/components/chatusage.mdx +++ b/docs/models/components/chatusage.mdx @@ -9,12 +9,12 @@ Token usage statistics | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `CompletionTokens` | `int64` | ✅ | Number of tokens in the completion | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsageCompletionTokensDetails](../../models/components/chatusagecompletiontokensdetails.mdx)] | ➖ | Detailed completion token usage | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `PromptTokens` | `int64` | ✅ | Number of tokens in the prompt | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsagePromptTokensDetails](../../models/components/chatusageprompttokensdetails.mdx)] | ➖ | Detailed prompt token usage | | -| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | -| `TotalTokens` | `int64` | ✅ | Total number of tokens | | \ No newline at end of file +| `CompletionTokens` | `int64` | :heavy_check_mark: | Number of tokens in the completion | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsageCompletionTokensDetails](../../models/components/chatusagecompletiontokensdetails.mdx)] | :heavy_minus_sign: | Detailed completion token usage | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `PromptTokens` | `int64` | :heavy_check_mark: | Number of tokens in the prompt | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsagePromptTokensDetails](../../models/components/chatusageprompttokensdetails.mdx)] | :heavy_minus_sign: | Detailed prompt token usage | | +| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | +| `TotalTokens` | `int64` | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file diff --git a/docs/models/components/chatusagecompletiontokensdetails.mdx b/docs/models/components/chatusagecompletiontokensdetails.mdx index e824b194b..f657f3448 100644 --- a/docs/models/components/chatusagecompletiontokensdetails.mdx +++ b/docs/models/components/chatusagecompletiontokensdetails.mdx @@ -9,7 +9,7 @@ Detailed completion token usage | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `AcceptedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Accepted prediction tokens | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for audio output | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for reasoning | -| `RejectedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Rejected prediction tokens | \ No newline at end of file +| `AcceptedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Accepted prediction tokens | +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for audio output | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for reasoning | +| `RejectedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Rejected prediction tokens | \ No newline at end of file diff --git a/docs/models/components/chatusageprompttokensdetails.mdx b/docs/models/components/chatusageprompttokensdetails.mdx index 566f2663f..4810cf7d8 100644 --- a/docs/models/components/chatusageprompttokensdetails.mdx +++ b/docs/models/components/chatusageprompttokensdetails.mdx @@ -9,7 +9,7 @@ Detailed prompt token usage | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | `*int64` | ➖ | Audio input tokens | -| `CacheWriteTokens` | `*int64` | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | `*int64` | ➖ | Cached prompt tokens | -| `VideoTokens` | `*int64` | ➖ | Video input tokens | \ No newline at end of file +| `AudioTokens` | `*int64` | :heavy_minus_sign: | Audio input tokens | +| `CacheWriteTokens` | `*int64` | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | `*int64` | :heavy_minus_sign: | Cached prompt tokens | +| `VideoTokens` | `*int64` | :heavy_minus_sign: | Video input tokens | \ No newline at end of file diff --git a/docs/models/components/chatusermessage.mdx b/docs/models/components/chatusermessage.mdx index 07d61f471..d1bf5ce4f 100644 --- a/docs/models/components/chatusermessage.mdx +++ b/docs/models/components/chatusermessage.mdx @@ -9,6 +9,6 @@ User message | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Content` | [components.ChatUserMessageContent](../../models/components/chatusermessagecontent.mdx) | ✅ | User message content | What is the capital of France? | -| `Name` | `*string` | ➖ | Optional name for the user | User | -| `Role` | [components.ChatUserMessageRole](../../models/components/chatusermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `Content` | [components.ChatUserMessageContent](../../models/components/chatusermessagecontent.mdx) | :heavy_check_mark: | User message content | What is the capital of France? | +| `Name` | `*string` | :heavy_minus_sign: | Optional name for the user | User | +| `Role` | [components.ChatUserMessageRole](../../models/components/chatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatwebsearchshorthand.mdx b/docs/models/components/chatwebsearchshorthand.mdx index 3f0216fb2..57c7dd399 100644 --- a/docs/models/components/chatwebsearchshorthand.mdx +++ b/docs/models/components/chatwebsearchshorthand.mdx @@ -9,16 +9,16 @@ Web search tool using OpenAI Responses API syntax. Automatically converted to op | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `ExcludedDomains` | []`string` | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `MaxCharacters` | `*int64` | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxTotalResults` | `*int64` | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `Type` | [components.ChatWebSearchShorthandType](../../models/components/chatwebsearchshorthandtype.mdx) | ✅ | N/A | | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `MaxCharacters` | `*int64` | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxTotalResults` | `*int64` | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `Type` | [components.ChatWebSearchShorthandType](../../models/components/chatwebsearchshorthandtype.mdx) | :heavy_check_mark: | N/A | | +| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/choice.mdx b/docs/models/components/choice.mdx index 369d0e9db..2c57c13fb 100644 --- a/docs/models/components/choice.mdx +++ b/docs/models/components/choice.mdx @@ -6,8 +6,8 @@ title: "Choice" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `FinishReason` | [components.FinishReason](../../models/components/finishreason.mdx) | ✅ | N/A | stop | -| `Index` | `int64` | ✅ | N/A | | -| `Logprobs` | [*components.Logprobs](../../models/components/logprobs.mdx) | ✅ | N/A | | -| `Message` | [components.Message](../../models/components/message.mdx) | ✅ | N/A | | -| `NativeFinishReason` | `*string` | ✅ | N/A | | \ No newline at end of file +| `FinishReason` | [components.FinishReason](../../models/components/finishreason.mdx) | :heavy_check_mark: | N/A | stop | +| `Index` | `int64` | :heavy_check_mark: | N/A | | +| `Logprobs` | [*components.Logprobs](../../models/components/logprobs.mdx) | :heavy_check_mark: | N/A | | +| `Message` | [components.Message](../../models/components/message.mdx) | :heavy_check_mark: | N/A | | +| `NativeFinishReason` | `*string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallcodedeltaevent.mdx b/docs/models/components/codeinterpretercallcodedeltaevent.mdx index 9384cd531..cacd126e1 100644 --- a/docs/models/components/codeinterpretercallcodedeltaevent.mdx +++ b/docs/models/components/codeinterpretercallcodedeltaevent.mdx @@ -9,8 +9,8 @@ Incremental chunk of code being streamed for a `code_interpreter_call`. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.CodeInterpreterCallCodeDeltaEventType](../../models/components/codeinterpretercallcodedeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.CodeInterpreterCallCodeDeltaEventType](../../models/components/codeinterpretercallcodedeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallcodedoneevent.mdx b/docs/models/components/codeinterpretercallcodedoneevent.mdx index 9ab93243c..2881a462d 100644 --- a/docs/models/components/codeinterpretercallcodedoneevent.mdx +++ b/docs/models/components/codeinterpretercallcodedoneevent.mdx @@ -9,8 +9,8 @@ Emitted when code streaming completes for a `code_interpreter_call`. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Code` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.CodeInterpreterCallCodeDoneEventType](../../models/components/codeinterpretercallcodedoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Code` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.CodeInterpreterCallCodeDoneEventType](../../models/components/codeinterpretercallcodedoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallcompletedevent.mdx b/docs/models/components/codeinterpretercallcompletedevent.mdx index ffacec43f..2f1bd1d44 100644 --- a/docs/models/components/codeinterpretercallcompletedevent.mdx +++ b/docs/models/components/codeinterpretercallcompletedevent.mdx @@ -9,7 +9,7 @@ Code interpreter call completed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.CodeInterpreterCallCompletedEventType](../../models/components/codeinterpretercallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.CodeInterpreterCallCompletedEventType](../../models/components/codeinterpretercallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallinprogressevent.mdx b/docs/models/components/codeinterpretercallinprogressevent.mdx index e4cdb0941..17e85cf0e 100644 --- a/docs/models/components/codeinterpretercallinprogressevent.mdx +++ b/docs/models/components/codeinterpretercallinprogressevent.mdx @@ -9,7 +9,7 @@ Code interpreter call in progress | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.CodeInterpreterCallInProgressEventType](../../models/components/codeinterpretercallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.CodeInterpreterCallInProgressEventType](../../models/components/codeinterpretercallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallinterpretingevent.mdx b/docs/models/components/codeinterpretercallinterpretingevent.mdx index b6413c2ab..90f2aae8e 100644 --- a/docs/models/components/codeinterpretercallinterpretingevent.mdx +++ b/docs/models/components/codeinterpretercallinterpretingevent.mdx @@ -9,7 +9,7 @@ Code interpreter is executing the code | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.CodeInterpreterCallInterpretingEventType](../../models/components/codeinterpretercallinterpretingeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.CodeInterpreterCallInterpretingEventType](../../models/components/codeinterpretercallinterpretingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterfileoutput.mdx b/docs/models/components/codeinterpreterfileoutput.mdx index b54069840..2ab8eb84c 100644 --- a/docs/models/components/codeinterpreterfileoutput.mdx +++ b/docs/models/components/codeinterpreterfileoutput.mdx @@ -6,13 +6,13 @@ title: "CodeInterpreterFileOutput" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DownloadURL` | `*string` | ➖ | Provider-issued download URL for the generated file. Typically signed and time-limited (see `expires_at`); fetch promptly rather than persisting the URL. | -| `ErrorCode` | optionalnullable.OptionalNullable[`string`] | ➖ | Provider error code when generating or persisting the file failed; null or absent on success. | -| `ExpiresAt` | `*string` | ➖ | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | -| `Filename` | `*string` | ➖ | N/A | -| `ID` | `*string` | ➖ | N/A | -| `MediaType` | `*string` | ➖ | N/A | -| `Sha256` | `*string` | ➖ | N/A | -| `SizeBytes` | `*int64` | ➖ | N/A | -| `Status` | `*string` | ➖ | Provider-reported readiness of the generated file (e.g. `ready`). Values other than `ready` indicate the artifact may not be downloadable. | -| `Type` | [components.CodeInterpreterFileOutputType](../../models/components/codeinterpreterfileoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `DownloadURL` | `*string` | :heavy_minus_sign: | Provider-issued download URL for the generated file. Typically signed and time-limited (see `expires_at`); fetch promptly rather than persisting the URL. | +| `ErrorCode` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Provider error code when generating or persisting the file failed; null or absent on success. | +| `ExpiresAt` | `*string` | :heavy_minus_sign: | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | +| `Filename` | `*string` | :heavy_minus_sign: | N/A | +| `ID` | `*string` | :heavy_minus_sign: | N/A | +| `MediaType` | `*string` | :heavy_minus_sign: | N/A | +| `Sha256` | `*string` | :heavy_minus_sign: | N/A | +| `SizeBytes` | `*int64` | :heavy_minus_sign: | N/A | +| `Status` | `*string` | :heavy_minus_sign: | Provider-reported readiness of the generated file (e.g. `ready`). Values other than `ready` indicate the artifact may not be downloadable. | +| `Type` | [components.CodeInterpreterFileOutputType](../../models/components/codeinterpreterfileoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterimageoutput.mdx b/docs/models/components/codeinterpreterimageoutput.mdx index b1f17b735..e84a5d592 100644 --- a/docs/models/components/codeinterpreterimageoutput.mdx +++ b/docs/models/components/codeinterpreterimageoutput.mdx @@ -6,5 +6,5 @@ title: "CodeInterpreterImageOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Type` | [components.CodeInterpreterImageOutputType](../../models/components/codeinterpreterimageoutputtype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.CodeInterpreterImageOutputType](../../models/components/codeinterpreterimageoutputtype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterlogsoutput.mdx b/docs/models/components/codeinterpreterlogsoutput.mdx index 7e8ae461d..a4c4d46a7 100644 --- a/docs/models/components/codeinterpreterlogsoutput.mdx +++ b/docs/models/components/codeinterpreterlogsoutput.mdx @@ -6,5 +6,5 @@ title: "CodeInterpreterLogsOutput" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Logs` | `string` | ✅ | N/A | -| `Type` | [components.CodeInterpreterLogsOutputType](../../models/components/codeinterpreterlogsoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Logs` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.CodeInterpreterLogsOutputType](../../models/components/codeinterpreterlogsoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterservertool.mdx b/docs/models/components/codeinterpreterservertool.mdx index d07484c5a..9a8544350 100644 --- a/docs/models/components/codeinterpreterservertool.mdx +++ b/docs/models/components/codeinterpreterservertool.mdx @@ -9,5 +9,5 @@ Code interpreter tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Container` | [components.Container](../../models/components/container.mdx) | ✅ | N/A | -| `Type` | [components.TypeCodeInterpreter](../../models/components/typecodeinterpreter.mdx) | ✅ | N/A | \ No newline at end of file +| `Container` | [components.Container](../../models/components/container.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeCodeInterpreter](../../models/components/typecodeinterpreter.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codexlocalshelltool.mdx b/docs/models/components/codexlocalshelltool.mdx index f9424cc21..7f7725af8 100644 --- a/docs/models/components/codexlocalshelltool.mdx +++ b/docs/models/components/codexlocalshelltool.mdx @@ -9,4 +9,4 @@ Local shell tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Type` | [components.CodexLocalShellToolType](../../models/components/codexlocalshelltooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.CodexLocalShellToolType](../../models/components/codexlocalshelltooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/compactionitem.mdx b/docs/models/components/compactionitem.mdx index 5d360e8aa..b7b846c91 100644 --- a/docs/models/components/compactionitem.mdx +++ b/docs/models/components/compactionitem.mdx @@ -9,7 +9,7 @@ A context compaction marker with encrypted summary | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `EncryptedContent` | `string` | ✅ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Type` | [components.CompactionItemType](../../models/components/compactionitemtype.mdx) | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file +| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.CompactionItemType](../../models/components/compactionitemtype.mdx) | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file diff --git a/docs/models/components/compoundfilter.mdx b/docs/models/components/compoundfilter.mdx index bfe89847d..7fbf1362d 100644 --- a/docs/models/components/compoundfilter.mdx +++ b/docs/models/components/compoundfilter.mdx @@ -9,5 +9,5 @@ A compound filter that combines multiple comparison or compound filters | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Filters` | []map[string]`any` | ✅ | N/A | -| `Type` | [components.CompoundFilterType](../../models/components/compoundfiltertype.mdx) | ✅ | N/A | \ No newline at end of file +| `Filters` | []map[string]`any` | :heavy_check_mark: | N/A | +| `Type` | [components.CompoundFilterType](../../models/components/compoundfiltertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/computeruseservertool.mdx b/docs/models/components/computeruseservertool.mdx index e9c4e08b1..33b8f8fc3 100644 --- a/docs/models/components/computeruseservertool.mdx +++ b/docs/models/components/computeruseservertool.mdx @@ -9,7 +9,7 @@ Computer use preview tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `DisplayHeight` | `int64` | ✅ | N/A | -| `DisplayWidth` | `int64` | ✅ | N/A | -| `Environment` | [components.Environment](../../models/components/environment.mdx) | ✅ | N/A | -| `Type` | [components.ComputerUseServerToolType](../../models/components/computeruseservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `DisplayHeight` | `int64` | :heavy_check_mark: | N/A | +| `DisplayWidth` | `int64` | :heavy_check_mark: | N/A | +| `Environment` | [components.Environment](../../models/components/environment.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ComputerUseServerToolType](../../models/components/computeruseservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/configurationupdateitem.mdx b/docs/models/components/configurationupdateitem.mdx index a40c7d52f..7c2ce6e55 100644 --- a/docs/models/components/configurationupdateitem.mdx +++ b/docs/models/components/configurationupdateitem.mdx @@ -9,6 +9,6 @@ Changes reasoning effort from this point in the conversation onward without inva | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | -| `Type` | [components.ConfigurationUpdateItemType](../../models/components/configurationupdateitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | +| `Type` | [components.ConfigurationUpdateItemType](../../models/components/configurationupdateitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/configurationupdatereasoning.mdx b/docs/models/components/configurationupdatereasoning.mdx index 8c57d0c95..a13d2a858 100644 --- a/docs/models/components/configurationupdatereasoning.mdx +++ b/docs/models/components/configurationupdatereasoning.mdx @@ -9,4 +9,4 @@ Reasoning settings applied from this point in the conversation onward | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Effort` | [components.ConfigurationUpdateReasoningEffort](../../models/components/configurationupdatereasoningeffort.mdx) | ✅ | Reasoning effort to apply from this point in the conversation onward | low | \ No newline at end of file +| `Effort` | [components.ConfigurationUpdateReasoningEffort](../../models/components/configurationupdatereasoningeffort.mdx) | :heavy_check_mark: | Reasoning effort to apply from this point in the conversation onward | low | \ No newline at end of file diff --git a/docs/models/components/conflictresponseerrordata.mdx b/docs/models/components/conflictresponseerrordata.mdx index bcffefd90..f7a2d6ffd 100644 --- a/docs/models/components/conflictresponseerrordata.mdx +++ b/docs/models/components/conflictresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ConflictResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/containerauto.mdx b/docs/models/components/containerauto.mdx index 28ec54494..f0a61aa66 100644 --- a/docs/models/components/containerauto.mdx +++ b/docs/models/components/containerauto.mdx @@ -6,6 +6,6 @@ title: "ContainerAuto" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `FileIds` | []`string` | ➖ | N/A | -| `MemoryLimit` | optionalnullable.OptionalNullable[[components.MemoryLimit](../../models/components/memorylimit.mdx)] | ➖ | N/A | -| `Type` | [components.ContainerType](../../models/components/containertype.mdx) | ✅ | N/A | \ No newline at end of file +| `FileIds` | []`string` | :heavy_minus_sign: | N/A | +| `MemoryLimit` | optionalnullable.OptionalNullable[[components.MemoryLimit](../../models/components/memorylimit.mdx)] | :heavy_minus_sign: | N/A | +| `Type` | [components.ContainerType](../../models/components/containertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/containerautoenvironment.mdx b/docs/models/components/containerautoenvironment.mdx index 3d7abff5e..0c022b727 100644 --- a/docs/models/components/containerautoenvironment.mdx +++ b/docs/models/components/containerautoenvironment.mdx @@ -9,6 +9,6 @@ An OpenRouter-managed, auto-provisioned ephemeral container. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `FileIds` | []`string` | ➖ | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | -| `NetworkPolicy` | [*components.ContainerNetworkPolicy](../../models/components/containernetworkpolicy.mdx) | ➖ | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | -| `Type` | [components.ContainerAutoEnvironmentType](../../models/components/containerautoenvironmenttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `FileIds` | []`string` | :heavy_minus_sign: | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | +| `NetworkPolicy` | [*components.ContainerNetworkPolicy](../../models/components/containernetworkpolicy.mdx) | :heavy_minus_sign: | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | +| `Type` | [components.ContainerAutoEnvironmentType](../../models/components/containerautoenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/containerfile.mdx b/docs/models/components/containerfile.mdx index 882b5794e..26ec73eda 100644 --- a/docs/models/components/containerfile.mdx +++ b/docs/models/components/containerfile.mdx @@ -6,10 +6,10 @@ title: "ContainerFile" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `Bytes` | `int64` | ✅ | File size in bytes. | 123 | -| `ContainerID` | `string` | ✅ | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | -| `CreatedAt` | `int64` | ✅ | Unix timestamp (seconds) when the file was last synced. | 1755640000 | -| `ID` | `string` | ✅ | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `Object` | [components.ContainerFileObject](../../models/components/containerfileobject.mdx) | ✅ | N/A | container.file | -| `Path` | `string` | ✅ | Container-relative file path. | out/report.csv | -| `Source` | [components.ContainerFileSource](../../models/components/containerfilesource.mdx) | ✅ | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file +| `Bytes` | `int64` | :heavy_check_mark: | File size in bytes. | 123 | +| `ContainerID` | `string` | :heavy_check_mark: | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | +| `CreatedAt` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) when the file was last synced. | 1755640000 | +| `ID` | `string` | :heavy_check_mark: | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `Object` | [components.ContainerFileObject](../../models/components/containerfileobject.mdx) | :heavy_check_mark: | N/A | container.file | +| `Path` | `string` | :heavy_check_mark: | Container-relative file path. | out/report.csv | +| `Source` | [components.ContainerFileSource](../../models/components/containerfilesource.mdx) | :heavy_check_mark: | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file diff --git a/docs/models/components/containerfilelistresponse.mdx b/docs/models/components/containerfilelistresponse.mdx index 06759ba1c..6269ff622 100644 --- a/docs/models/components/containerfilelistresponse.mdx +++ b/docs/models/components/containerfilelistresponse.mdx @@ -6,8 +6,8 @@ title: "ContainerFileListResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.ContainerFile](../../models/components/containerfile.mdx) | ✅ | N/A | | -| `FirstID` | `*string` | ✅ | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | -| `HasMore` | `bool` | ✅ | True when another page can be fetched by passing `after=last_id`; `last_id` is non-null whenever this is true. | false | -| `LastID` | `*string` | ✅ | Cursor for the next page (pass as `after`). The last entry’s id, except when the page stopped at the per-request scan bound on hidden bookkeeping objects: then it names the scan position and may not appear in `data`. Null only when `has_more` is false and `data` is empty. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `Object` | [components.ContainerFileListResponseObject](../../models/components/containerfilelistresponseobject.mdx) | ✅ | N/A | list | \ No newline at end of file +| `Data` | [][components.ContainerFile](../../models/components/containerfile.mdx) | :heavy_check_mark: | N/A | | +| `FirstID` | `*string` | :heavy_check_mark: | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | +| `HasMore` | `bool` | :heavy_check_mark: | True when another page can be fetched by passing `after=last_id`; `last_id` is non-null whenever this is true. | false | +| `LastID` | `*string` | :heavy_check_mark: | Cursor for the next page (pass as `after`). The last entry’s id, except when the page stopped at the per-request scan bound on hidden bookkeeping objects: then it names the scan position and may not appear in `data`. Null only when `has_more` is false and `data` is empty. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `Object` | [components.ContainerFileListResponseObject](../../models/components/containerfilelistresponseobject.mdx) | :heavy_check_mark: | N/A | list | \ No newline at end of file diff --git a/docs/models/components/containernetworkpolicyallowlist.mdx b/docs/models/components/containernetworkpolicyallowlist.mdx index 405cb8462..66a74b43b 100644 --- a/docs/models/components/containernetworkpolicyallowlist.mdx +++ b/docs/models/components/containernetworkpolicyallowlist.mdx @@ -6,5 +6,5 @@ title: "ContainerNetworkPolicyAllowlist" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedDomains` | []`string` | ✅ | Hostnames the container may reach over ports 80/443 (max 50). Entries are lowercase hostnames or glob patterns where * matches any run of characters (e.g. *.example.com). An exact hostname does not cover its subdomains — use a glob or list each hostname. pip needs both pypi.org and files.pythonhosted.org (or *.pythonhosted.org). | [
"pypi.org",
"files.pythonhosted.org"
] | -| `Type` | [components.TypeAllowlist](../../models/components/typeallowlist.mdx) | ✅ | Outbound access restricted to the listed domains. | | \ No newline at end of file +| `AllowedDomains` | []`string` | :heavy_check_mark: | Hostnames the container may reach over ports 80/443 (max 50). Entries are lowercase hostnames or glob patterns where * matches any run of characters (e.g. *.example.com). An exact hostname does not cover its subdomains — use a glob or list each hostname. pip needs both pypi.org and files.pythonhosted.org (or *.pythonhosted.org). | [
"pypi.org",
"files.pythonhosted.org"
] | +| `Type` | [components.TypeAllowlist](../../models/components/typeallowlist.mdx) | :heavy_check_mark: | Outbound access restricted to the listed domains. | | \ No newline at end of file diff --git a/docs/models/components/containernetworkpolicydisabled.mdx b/docs/models/components/containernetworkpolicydisabled.mdx index 12c57f2f4..85be85d3b 100644 --- a/docs/models/components/containernetworkpolicydisabled.mdx +++ b/docs/models/components/containernetworkpolicydisabled.mdx @@ -6,4 +6,4 @@ title: "ContainerNetworkPolicyDisabled" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.ContainerNetworkPolicyTypeDisabled](../../models/components/containernetworkpolicytypedisabled.mdx) | ✅ | No outbound internet access. | \ No newline at end of file +| `Type` | [components.ContainerNetworkPolicyTypeDisabled](../../models/components/containernetworkpolicytypedisabled.mdx) | :heavy_check_mark: | No outbound internet access. | \ No newline at end of file diff --git a/docs/models/components/containerreferenceenvironment.mdx b/docs/models/components/containerreferenceenvironment.mdx index 1ab47d38e..7be53eeb9 100644 --- a/docs/models/components/containerreferenceenvironment.mdx +++ b/docs/models/components/containerreferenceenvironment.mdx @@ -9,7 +9,7 @@ Reference to a container by its canonical id — a previously returned container | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | Canonical container id to reuse (max 40 characters, letters/digits/underscores/hyphens). Any container_id previously returned by a bash or shell tool result works here and reattaches to the same container and files — including session-derived ids (sess_...) and generation-derived ids (gen_...). Note that a session-derived id is always sess_ + the sanitized session key, which is not necessarily the raw session id you sent. Using the same container_id from both the bash and shell tools shares the same files, with last-write-wins when both flush concurrently. A fresh name creates a new persistent container. Containers are always scoped to your account and workspace. | sess_abc123 | -| `FileIds` | []`string` | ➖ | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | -| `NetworkPolicy` | [*components.ContainerNetworkPolicy](../../models/components/containernetworkpolicy.mdx) | ➖ | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | -| `Type` | [components.ContainerReferenceEnvironmentType](../../models/components/containerreferenceenvironmenttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | Canonical container id to reuse (max 40 characters, letters/digits/underscores/hyphens). Any container_id previously returned by a bash or shell tool result works here and reattaches to the same container and files — including session-derived ids (sess_...) and generation-derived ids (gen_...). Note that a session-derived id is always sess_ + the sanitized session key, which is not necessarily the raw session id you sent. Using the same container_id from both the bash and shell tools shares the same files, with last-write-wins when both flush concurrently. A fresh name creates a new persistent container. Containers are always scoped to your account and workspace. | sess_abc123 | +| `FileIds` | []`string` | :heavy_minus_sign: | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | +| `NetworkPolicy` | [*components.ContainerNetworkPolicy](../../models/components/containernetworkpolicy.mdx) | :heavy_minus_sign: | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | +| `Type` | [components.ContainerReferenceEnvironmentType](../../models/components/containerreferenceenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentcompaction.mdx b/docs/models/components/contentcompaction.mdx index 5fec86138..c29bc3322 100644 --- a/docs/models/components/contentcompaction.mdx +++ b/docs/models/components/contentcompaction.mdx @@ -6,7 +6,7 @@ title: "ContentCompaction" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Content` | `*string` | ✅ | N/A | | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Type` | [components.MessagesMessageParamTypeCompaction](../../models/components/messagesmessageparamtypecompaction.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Content` | `*string` | :heavy_check_mark: | N/A | | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.MessagesMessageParamTypeCompaction](../../models/components/messagesmessageparamtypecompaction.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentencryptedcontent.mdx b/docs/models/components/contentencryptedcontent.mdx index 90b387d63..ddd84c8e7 100644 --- a/docs/models/components/contentencryptedcontent.mdx +++ b/docs/models/components/contentencryptedcontent.mdx @@ -6,6 +6,6 @@ title: "ContentEncryptedContent" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `EncryptedContent` | `string` | ✅ | N/A | -| `Type` | [components.TypeEncryptedContent](../../models/components/typeencryptedcontent.mdx) | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.TypeEncryptedContent](../../models/components/typeencryptedcontent.mdx) | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentfilterbuiltinentry.mdx b/docs/models/components/contentfilterbuiltinentry.mdx index fe2e1e5d4..36e3d28de 100644 --- a/docs/models/components/contentfilterbuiltinentry.mdx +++ b/docs/models/components/contentfilterbuiltinentry.mdx @@ -9,7 +9,7 @@ A builtin content filter entry. Builtin filters include PII detectors, API-key a | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | -| `Label` | `*string` | ➖ | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | -| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope.mdx) | ➖ | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | -| `Slug` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | +| `Label` | `*string` | :heavy_minus_sign: | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | +| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope.mdx) | :heavy_minus_sign: | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | +| `Slug` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/components/contentfilterbuiltinentryinput.mdx b/docs/models/components/contentfilterbuiltinentryinput.mdx index e48650c9c..5a92789b3 100644 --- a/docs/models/components/contentfilterbuiltinentryinput.mdx +++ b/docs/models/components/contentfilterbuiltinentryinput.mdx @@ -9,7 +9,7 @@ A builtin content filter entry for create/update requests. Labels are system-ass | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | -| ~~`Label`~~ | `*string` | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: labels are system-assigned and cannot be set by the caller. Accepted for backward compatibility but silently ignored. | | -| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope.mdx) | ➖ | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | -| `Slug` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | +| ~~`Label`~~ | `*string` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: labels are system-assigned and cannot be set by the caller. Accepted for backward compatibility but silently ignored. | | +| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope.mdx) | :heavy_minus_sign: | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | +| `Slug` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/components/contentfilterentry.mdx b/docs/models/components/contentfilterentry.mdx index bad791ebf..b48bd98f8 100644 --- a/docs/models/components/contentfilterentry.mdx +++ b/docs/models/components/contentfilterentry.mdx @@ -9,6 +9,6 @@ A custom regex content filter that scans request messages for matching patterns. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterAction](../../models/components/contentfilteraction.mdx) | ✅ | Action taken when the pattern matches | block | -| `Label` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional label used in redaction placeholders or error messages | [API_KEY] | -| `Pattern` | `string` | ✅ | A regex pattern to match against request content | \b(sk-[a-zA-Z0-9]\{48})\b | \ No newline at end of file +| `Action` | [components.ContentFilterAction](../../models/components/contentfilteraction.mdx) | :heavy_check_mark: | Action taken when the pattern matches | block | +| `Label` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional label used in redaction placeholders or error messages | [API_KEY] | +| `Pattern` | `string` | :heavy_check_mark: | A regex pattern to match against request content | \b(sk-[a-zA-Z0-9]\{48})\b | \ No newline at end of file diff --git a/docs/models/components/contentimageurl.mdx b/docs/models/components/contentimageurl.mdx index 9dfeb1b04..dd326660a 100644 --- a/docs/models/components/contentimageurl.mdx +++ b/docs/models/components/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ImageURL` | [components.ContentImageURLImageURL](../../models/components/contentimageurlimageurl.mdx) | ✅ | N/A | -| `Type` | [components.FileTypeImageURL](../../models/components/filetypeimageurl.mdx) | ✅ | N/A | \ No newline at end of file +| `ImageURL` | [components.ContentImageURLImageURL](../../models/components/contentimageurlimageurl.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.FileTypeImageURL](../../models/components/filetypeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentimageurlimageurl.mdx b/docs/models/components/contentimageurlimageurl.mdx index 09954e882..1328a98d5 100644 --- a/docs/models/components/contentimageurlimageurl.mdx +++ b/docs/models/components/contentimageurlimageurl.mdx @@ -6,4 +6,4 @@ title: "ContentImageURLImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartaddedevent.mdx b/docs/models/components/contentpartaddedevent.mdx index 88a75e880..0ff8554c9 100644 --- a/docs/models/components/contentpartaddedevent.mdx +++ b/docs/models/components/contentpartaddedevent.mdx @@ -9,9 +9,9 @@ Event emitted when a new content part is added to an output item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `Part` | [components.ContentPartAddedEventPart](../../models/components/contentpartaddedeventpart.mdx) | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ContentPartAddedEventType](../../models/components/contentpartaddedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `Part` | [components.ContentPartAddedEventPart](../../models/components/contentpartaddedeventpart.mdx) | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ContentPartAddedEventType](../../models/components/contentpartaddedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartaudio.mdx b/docs/models/components/contentpartaudio.mdx index 36f5ccf4a..caf675127 100644 --- a/docs/models/components/contentpartaudio.mdx +++ b/docs/models/components/contentpartaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartAudio" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `AudioURL` | [components.AudioURL](../../models/components/audiourl.mdx) | ✅ | N/A | -| `Type` | [components.ContentPartAudioType](../../models/components/contentpartaudiotype.mdx) | ✅ | N/A | \ No newline at end of file +| `AudioURL` | [components.AudioURL](../../models/components/audiourl.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ContentPartAudioType](../../models/components/contentpartaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartdoneevent.mdx b/docs/models/components/contentpartdoneevent.mdx index 9d3854394..864566ba6 100644 --- a/docs/models/components/contentpartdoneevent.mdx +++ b/docs/models/components/contentpartdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when a content part is complete | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `Part` | [components.ContentPartDoneEventPart](../../models/components/contentpartdoneeventpart.mdx) | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ContentPartDoneEventType](../../models/components/contentpartdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `Part` | [components.ContentPartDoneEventPart](../../models/components/contentpartdoneeventpart.mdx) | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ContentPartDoneEventType](../../models/components/contentpartdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartimage.mdx b/docs/models/components/contentpartimage.mdx index d12776a64..38f6d6a38 100644 --- a/docs/models/components/contentpartimage.mdx +++ b/docs/models/components/contentpartimage.mdx @@ -6,5 +6,5 @@ title: "ContentPartImage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ContentPartImageImageURL](../../models/components/contentpartimageimageurl.mdx) | ✅ | N/A | -| `Type` | [components.ContentPartImageType](../../models/components/contentpartimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `ImageURL` | [components.ContentPartImageImageURL](../../models/components/contentpartimageimageurl.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ContentPartImageType](../../models/components/contentpartimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartimageimageurl.mdx b/docs/models/components/contentpartimageimageurl.mdx index 28dc58406..cb2bb88a3 100644 --- a/docs/models/components/contentpartimageimageurl.mdx +++ b/docs/models/components/contentpartimageimageurl.mdx @@ -6,4 +6,4 @@ title: "ContentPartImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartinputaudio.mdx b/docs/models/components/contentpartinputaudio.mdx index 16c0346ad..3a57ab34d 100644 --- a/docs/models/components/contentpartinputaudio.mdx +++ b/docs/models/components/contentpartinputaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputAudio" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputAudioType](../../models/components/contentpartinputaudiotype.mdx) | ✅ | N/A | | \ No newline at end of file +| `InputAudio` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputAudioType](../../models/components/contentpartinputaudiotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartinputfile.mdx b/docs/models/components/contentpartinputfile.mdx index 2da178d04..53966b872 100644 --- a/docs/models/components/contentpartinputfile.mdx +++ b/docs/models/components/contentpartinputfile.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputFile" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `InputFile` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputFileType](../../models/components/contentpartinputfiletype.mdx) | ✅ | N/A | | \ No newline at end of file +| `InputFile` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputFileType](../../models/components/contentpartinputfiletype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartinputvideo.mdx b/docs/models/components/contentpartinputvideo.mdx index 8c102fab1..8e03b7472 100644 --- a/docs/models/components/contentpartinputvideo.mdx +++ b/docs/models/components/contentpartinputvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputVideo" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `InputVideo` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputVideoType](../../models/components/contentpartinputvideotype.mdx) | ✅ | N/A | | \ No newline at end of file +| `InputVideo` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputVideoType](../../models/components/contentpartinputvideotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartvideo.mdx b/docs/models/components/contentpartvideo.mdx index 5973f9b52..42e9a7d29 100644 --- a/docs/models/components/contentpartvideo.mdx +++ b/docs/models/components/contentpartvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartVideo" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.ContentPartVideoType](../../models/components/contentpartvideotype.mdx) | ✅ | N/A | -| `VideoURL` | [components.VideoURL](../../models/components/videourl.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.ContentPartVideoType](../../models/components/contentpartvideotype.mdx) | :heavy_check_mark: | N/A | +| `VideoURL` | [components.VideoURL](../../models/components/videourl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentredactedthinking.mdx b/docs/models/components/contentredactedthinking.mdx index e755ede21..018f5cbd7 100644 --- a/docs/models/components/contentredactedthinking.mdx +++ b/docs/models/components/contentredactedthinking.mdx @@ -6,5 +6,5 @@ title: "ContentRedactedThinking" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | ✅ | N/A | -| `Type` | [components.MessagesMessageParamTypeRedactedThinking](../../models/components/messagesmessageparamtyperedactedthinking.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesMessageParamTypeRedactedThinking](../../models/components/messagesmessageparamtyperedactedthinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentservertooluse.mdx b/docs/models/components/contentservertooluse.mdx index e868c05f1..dc706284e 100644 --- a/docs/models/components/contentservertooluse.mdx +++ b/docs/models/components/contentservertooluse.mdx @@ -6,8 +6,8 @@ title: "ContentServerToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `ID` | `string` | ✅ | N/A | | -| `Input` | `any` | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Type` | [components.MessagesMessageParamTypeServerToolUse](../../models/components/messagesmessageparamtypeservertooluse.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Input` | `any` | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.MessagesMessageParamTypeServerToolUse](../../models/components/messagesmessageparamtypeservertooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contenttext.mdx b/docs/models/components/contenttext.mdx index 4e3541eb2..e92d1c327 100644 --- a/docs/models/components/contenttext.mdx +++ b/docs/models/components/contenttext.mdx @@ -6,5 +6,5 @@ title: "ContentText" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.BatchObjectFileTypeText](../../models/components/batchobjectfiletypetext.mdx) | ✅ | N/A | \ No newline at end of file +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.BatchObjectFileTypeText](../../models/components/batchobjectfiletypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentthinking.mdx b/docs/models/components/contentthinking.mdx index 5fe1f0bce..625af8ff2 100644 --- a/docs/models/components/contentthinking.mdx +++ b/docs/models/components/contentthinking.mdx @@ -6,6 +6,6 @@ title: "ContentThinking" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Signature` | `string` | ✅ | N/A | -| `Thinking` | `string` | ✅ | N/A | -| `Type` | [components.MessagesMessageParamTypeThinking](../../models/components/messagesmessageparamtypethinking.mdx) | ✅ | N/A | \ No newline at end of file +| `Signature` | `string` | :heavy_check_mark: | N/A | +| `Thinking` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesMessageParamTypeThinking](../../models/components/messagesmessageparamtypethinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contenttoolreference.mdx b/docs/models/components/contenttoolreference.mdx index 7a2d5a419..cee24863d 100644 --- a/docs/models/components/contenttoolreference.mdx +++ b/docs/models/components/contenttoolreference.mdx @@ -6,5 +6,5 @@ title: "ContentToolReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ToolName` | `string` | ✅ | N/A | -| `Type` | [components.MessagesMessageParamTypeToolReference](../../models/components/messagesmessageparamtypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `ToolName` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesMessageParamTypeToolReference](../../models/components/messagesmessageparamtypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contenttoolresult.mdx b/docs/models/components/contenttoolresult.mdx index e539309d3..13241baa3 100644 --- a/docs/models/components/contenttoolresult.mdx +++ b/docs/models/components/contenttoolresult.mdx @@ -6,8 +6,8 @@ title: "ContentToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Content` | [*components.MessagesMessageParamContentUnion2](../../models/components/messagesmessageparamcontentunion2.mdx) | ➖ | N/A | | -| `IsError` | `*bool` | ➖ | N/A | | -| `ToolUseID` | `string` | ✅ | N/A | | -| `Type` | [components.TypeToolResult](../../models/components/typetoolresult.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Content` | [*components.MessagesMessageParamContentUnion2](../../models/components/messagesmessageparamcontentunion2.mdx) | :heavy_minus_sign: | N/A | | +| `IsError` | `*bool` | :heavy_minus_sign: | N/A | | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeToolResult](../../models/components/typetoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contenttooluse.mdx b/docs/models/components/contenttooluse.mdx index c76cc9875..5432648fe 100644 --- a/docs/models/components/contenttooluse.mdx +++ b/docs/models/components/contenttooluse.mdx @@ -6,8 +6,8 @@ title: "ContentToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `ID` | `string` | ✅ | N/A | | -| `Input` | `any` | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Type` | [components.MessagesMessageParamTypeToolUse](../../models/components/messagesmessageparamtypetooluse.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Input` | `any` | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.MessagesMessageParamTypeToolUse](../../models/components/messagesmessageparamtypetooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contenttoplogprob.mdx b/docs/models/components/contenttoplogprob.mdx index b27301c52..6b398df96 100644 --- a/docs/models/components/contenttoplogprob.mdx +++ b/docs/models/components/contenttoplogprob.mdx @@ -6,6 +6,6 @@ title: "ContentTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | ✅ | N/A | -| `Logprob` | `float64` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_check_mark: | N/A | +| `Logprob` | `float64` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentwebsearchtoolresult.mdx b/docs/models/components/contentwebsearchtoolresult.mdx index 0ac434b95..cc9a9c07f 100644 --- a/docs/models/components/contentwebsearchtoolresult.mdx +++ b/docs/models/components/contentwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "ContentWebSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Content` | [components.MessagesMessageParamContentUnion3](../../models/components/messagesmessageparamcontentunion3.mdx) | ✅ | N/A | | -| `ToolUseID` | `string` | ✅ | N/A | | -| `Type` | [components.MessagesMessageParamTypeWebSearchToolResult](../../models/components/messagesmessageparamtypewebsearchtoolresult.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Content` | [components.MessagesMessageParamContentUnion3](../../models/components/messagesmessageparamcontentunion3.mdx) | :heavy_check_mark: | N/A | | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.MessagesMessageParamTypeWebSearchToolResult](../../models/components/messagesmessageparamtypewebsearchtoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentwebsearchtoolresulterror.mdx b/docs/models/components/contentwebsearchtoolresulterror.mdx index fc52f1423..0c7fb33ee 100644 --- a/docs/models/components/contentwebsearchtoolresulterror.mdx +++ b/docs/models/components/contentwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "ContentWebSearchToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `ErrorCode` | [components.MessagesMessageParamErrorCode](../../models/components/messagesmessageparamerrorcode.mdx) | ✅ | N/A | -| `Type` | [components.MessagesMessageParamTypeWebSearchToolResultError](../../models/components/messagesmessageparamtypewebsearchtoolresulterror.mdx) | ✅ | N/A | \ No newline at end of file +| `ErrorCode` | [components.MessagesMessageParamErrorCode](../../models/components/messagesmessageparamerrorcode.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesMessageParamTypeWebSearchToolResultError](../../models/components/messagesmessageparamtypewebsearchtoolresulterror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contextcompactionitem.mdx b/docs/models/components/contextcompactionitem.mdx index b5ee4936f..8ac1ee1ca 100644 --- a/docs/models/components/contextcompactionitem.mdx +++ b/docs/models/components/contextcompactionitem.mdx @@ -9,7 +9,7 @@ A context compaction marker with an optional encrypted summary | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Type` | [components.ContextCompactionItemType](../../models/components/contextcompactionitemtype.mdx) | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.ContextCompactionItemType](../../models/components/contextcompactionitemtype.mdx) | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file diff --git a/docs/models/components/contextcompressionplugin.mdx b/docs/models/components/contextcompressionplugin.mdx index c51fa60fd..50c79da24 100644 --- a/docs/models/components/contextcompressionplugin.mdx +++ b/docs/models/components/contextcompressionplugin.mdx @@ -6,6 +6,6 @@ title: "ContextCompressionPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | ➖ | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `Engine` | [*components.ContextCompressionEngine](../../models/components/contextcompressionengine.mdx) | ➖ | The compression engine to use. Defaults to "middle-out". | middle-out | -| `ID` | [components.ContextCompressionPluginID](../../models/components/contextcompressionpluginid.mdx) | ✅ | N/A | | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | +| `Engine` | [*components.ContextCompressionEngine](../../models/components/contextcompressionengine.mdx) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | +| `ID` | [components.ContextCompressionPluginID](../../models/components/contextcompressionpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contextmanagement.mdx b/docs/models/components/contextmanagement.mdx index b6fa7bcbe..be2538c0e 100644 --- a/docs/models/components/contextmanagement.mdx +++ b/docs/models/components/contextmanagement.mdx @@ -6,4 +6,4 @@ title: "ContextManagement" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `Edits` | [][components.Edit](../../models/components/edit.mdx) | ➖ | N/A | \ No newline at end of file +| `Edits` | [][components.Edit](../../models/components/edit.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/contradiction.mdx b/docs/models/components/contradiction.mdx index 70f03571a..eff1167cf 100644 --- a/docs/models/components/contradiction.mdx +++ b/docs/models/components/contradiction.mdx @@ -6,5 +6,5 @@ title: "Contradiction" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Stances` | [][components.Stance](../../models/components/stance.mdx) | ✅ | N/A | -| `Topic` | `string` | ✅ | N/A | \ No newline at end of file +| `Stances` | [][components.Stance](../../models/components/stance.mdx) | :heavy_check_mark: | N/A | +| `Topic` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/costdetails.mdx b/docs/models/components/costdetails.mdx index f1e37a790..3fc74c6e1 100644 --- a/docs/models/components/costdetails.mdx +++ b/docs/models/components/costdetails.mdx @@ -9,7 +9,7 @@ Breakdown of upstream inference costs | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ServerToolCost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | -| `UpstreamInferenceCompletionsCost` | `float64` | ✅ | N/A | -| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | -| `UpstreamInferencePromptCost` | `float64` | ✅ | N/A | \ No newline at end of file +| `ServerToolCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | +| `UpstreamInferenceCompletionsCost` | `float64` | :heavy_check_mark: | N/A | +| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | +| `UpstreamInferencePromptCost` | `float64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createbyokkeyrequest.mdx b/docs/models/components/createbyokkeyrequest.mdx index 218a40e6c..5e93353b2 100644 --- a/docs/models/components/createbyokkeyrequest.mdx +++ b/docs/models/components/createbyokkeyrequest.mdx @@ -6,16 +6,16 @@ title: "CreateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedAPIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.CreateBYOKKeyRequestDeclaredRegion](../../models/components/createbyokkeyrequestdeclaredregion.mdx)] | ➖ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. | null | -| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Defaults to `null`. | null | -| `Disabled` | `*bool` | ➖ | Whether this credential should be created in a disabled state. | false | -| `IsBYOKOnly` | `*bool` | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Defaults to `false`. | false | -| `IsFallback` | `*bool` | ➖ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | -| `IsRequired` | `*bool` | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Defaults to `false`. | false | -| `Key` | `string` | ✅ | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | -| `Name` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | -| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `WorkspaceID` | `*string` | ➖ | Optional workspace ID to scope the credential to. When omitted, the credential is created in the account's default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `AllowedAPIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.CreateBYOKKeyRequestDeclaredRegion](../../models/components/createbyokkeyrequestdeclaredregion.mdx)] | :heavy_minus_sign: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. | null | +| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Defaults to `null`. | null | +| `Disabled` | `*bool` | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | +| `IsBYOKOnly` | `*bool` | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Defaults to `false`. | false | +| `IsFallback` | `*bool` | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | +| `IsRequired` | `*bool` | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Defaults to `false`. | false | +| `Key` | `string` | :heavy_check_mark: | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | +| `Name` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | +| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to scope the credential to. When omitted, the credential is created in the account's default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/createbyokkeyresponse.mdx b/docs/models/components/createbyokkeyresponse.mdx index 5f9e0ba2d..c0e18d9d9 100644 --- a/docs/models/components/createbyokkeyresponse.mdx +++ b/docs/models/components/createbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "CreateBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/createenduserrequest.mdx b/docs/models/components/createenduserrequest.mdx index e2b7af870..695800505 100644 --- a/docs/models/components/createenduserrequest.mdx +++ b/docs/models/components/createenduserrequest.mdx @@ -4,6 +4,6 @@ title: "CreateEndUserRequest" ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file diff --git a/docs/models/components/createguardrailrequest.mdx b/docs/models/components/createguardrailrequest.mdx index 20144c856..a66d2aa1f 100644 --- a/docs/models/components/createguardrailrequest.mdx +++ b/docs/models/components/createguardrailrequest.mdx @@ -6,25 +6,25 @@ title: "CreateGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput.mdx)] | ➖ | Builtin content filters to apply. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | -| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | ➖ | Custom regex content filters to apply to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | Description of the guardrail | A guardrail for limiting API usage | -| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | -| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | -| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | -| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Defaults to false. | false | -| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | ➖ | Spending limit in USD. Must be provided together with `reset_interval`: a request that sets only one of the two is rejected with a 400. | 50 | -| `Name` | `string` | ✅ | Name for the new guardrail | My New Guardrail | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `WorkspaceID` | `*string` | ➖ | The workspace to create the guardrail in. When omitted, the guardrail is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. This only places the guardrail in the workspace; the created guardrail enforces nothing for that workspace's traffic until it is assigned to API keys or members. To restrict all traffic in a workspace, update the workspace's default guardrail instead. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput.mdx)] | :heavy_minus_sign: | Builtin content filters to apply. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | +| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | +| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | +| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | +| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | +| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | +| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Defaults to false. | false | +| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Spending limit in USD. Must be provided together with `reset_interval`: a request that sets only one of the two is rejected with a 400. | 50 | +| `Name` | `string` | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | The workspace to create the guardrail in. When omitted, the guardrail is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. This only places the guardrail in the workspace; the created guardrail enforces nothing for that workspace's traffic until it is assigned to API keys or members. To restrict all traffic in a workspace, update the workspace's default guardrail instead. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/components/createguardrailresponse.mdx b/docs/models/components/createguardrailresponse.mdx index 813b35f37..0c0484aff 100644 --- a/docs/models/components/createguardrailresponse.mdx +++ b/docs/models/components/createguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "CreateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/components/createinternrequest.mdx b/docs/models/components/createinternrequest.mdx index 18c787ed4..77788102a 100644 --- a/docs/models/components/createinternrequest.mdx +++ b/docs/models/components/createinternrequest.mdx @@ -9,9 +9,9 @@ Settings for a new intern. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | Free-form description, or null. | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | ➖ | Standing instructions the intern boots with, or null. | -| `Name` | `string` | ✅ | Intern name, unique per creator within the workspace. | -| `Provision` | `*bool` | ➖ | Start provisioning during this create operation. Defaults to false. | -| `VaultID` | `*string` | ➖ | Vault owned by another intern in this workspace to attach as a borrowed vault. | -| `WorkspaceID` | `*string` | ➖ | Workspace that will own the intern. Defaults to the workspace the API key resolves to. When given, it must match the API key workspace. | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Free-form description, or null. | +| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Standing instructions the intern boots with, or null. | +| `Name` | `string` | :heavy_check_mark: | Intern name, unique per creator within the workspace. | +| `Provision` | `*bool` | :heavy_minus_sign: | Start provisioning during this create operation. Defaults to false. | +| `VaultID` | `*string` | :heavy_minus_sign: | Vault owned by another intern in this workspace to attach as a borrowed vault. | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace that will own the intern. Defaults to the workspace the API key resolves to. When given, it must match the API key workspace. | \ No newline at end of file diff --git a/docs/models/components/createobservabilitydestinationrequest.mdx b/docs/models/components/createobservabilitydestinationrequest.mdx index 5b08cfdfd..c91f0d16d 100644 --- a/docs/models/components/createobservabilitydestinationrequest.mdx +++ b/docs/models/components/createobservabilitydestinationrequest.mdx @@ -6,16 +6,16 @@ title: "CreateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided. | null | -| `BroadcastGenerationCost` | `*bool` | ➖ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `*bool` | ➖ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `*bool` | ➖ | When true, include request-context generation metadata. | false | -| `Config` | map[string]`any` | ✅ | Provider-specific configuration. The shape depends on `type` and is validated server-side. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | -| `Enabled` | `*bool` | ➖ | Whether this destination should be enabled immediately. | true | -| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | ➖ | Optional structured filter rules controlling which events are forwarded. | null | -| `Name` | `string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `*bool` | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegionInput](../../models/components/observabilitydataregioninput.mdx) | ➖ | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field defaults to ['global']; the array must be non-empty. | [
"global"
] | -| `SamplingRate` | `*float64` | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.CreateObservabilityDestinationRequestType](../../models/components/createobservabilitydestinationrequesttype.mdx) | ✅ | The destination type. Only stable destination types are accepted. | langfuse | -| `WorkspaceID` | `*string` | ➖ | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided. | null | +| `BroadcastGenerationCost` | `*bool` | :heavy_minus_sign: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `*bool` | :heavy_minus_sign: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `*bool` | :heavy_minus_sign: | When true, include request-context generation metadata. | false | +| `Config` | map[string]`any` | :heavy_check_mark: | Provider-specific configuration. The shape depends on `type` and is validated server-side. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | +| `Enabled` | `*bool` | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | +| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | +| `Name` | `string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `*bool` | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegionInput](../../models/components/observabilitydataregioninput.mdx) | :heavy_minus_sign: | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field defaults to ['global']; the array must be non-empty. | [
"global"
] | +| `SamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.CreateObservabilityDestinationRequestType](../../models/components/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/createobservabilitydestinationresponse.mdx b/docs/models/components/createobservabilitydestinationresponse.mdx index 61fd51956..a54ab81b9 100644 --- a/docs/models/components/createobservabilitydestinationresponse.mdx +++ b/docs/models/components/createobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "CreateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/createpresetfrominferenceresponse.mdx b/docs/models/components/createpresetfrominferenceresponse.mdx index 765b9e6ec..1dc095a80 100644 --- a/docs/models/components/createpresetfrominferenceresponse.mdx +++ b/docs/models/components/createpresetfrominferenceresponse.mdx @@ -9,4 +9,4 @@ Response containing the created preset with its designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion.mdx) | ✅ | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file +| `Data` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion.mdx) | :heavy_check_mark: | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file diff --git a/docs/models/components/createprivateendpointrequest.mdx b/docs/models/components/createprivateendpointrequest.mdx index c76cce7fd..e99c53a17 100644 --- a/docs/models/components/createprivateendpointrequest.mdx +++ b/docs/models/components/createprivateendpointrequest.mdx @@ -6,11 +6,11 @@ title: "CreatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Activate` | [*components.PrivateEndpointActivation](../../models/components/privateendpointactivation.mdx) | ➖ | Validate and activate in the same call. On a failed validation the draft is kept and returned with a 422, so fix it and call `/validate` and `/activate` instead of creating it again. | \{
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `BaseURL` | `*string` | ➖ | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.CreatePrivateEndpointRequestDeclaredRegion](../../models/components/createprivateendpointrequestdeclaredregion.mdx)] | ➖ | Attest where this deployment processes data. | us | -| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Attest that this deployment retains no prompt or completion data. | | -| `ModelPermaslug` | `string` | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `Pricing` | [*components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | ➖ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `ProviderSlug` | `string` | ✅ | Slug of the upstream provider. | azure | -| `UpstreamModelID` | `string` | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `Activate` | [*components.PrivateEndpointActivation](../../models/components/privateendpointactivation.mdx) | :heavy_minus_sign: | Validate and activate in the same call. On a failed validation the draft is kept and returned with a 422, so fix it and call `/validate` and `/activate` instead of creating it again. | \{
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `BaseURL` | `*string` | :heavy_minus_sign: | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.CreatePrivateEndpointRequestDeclaredRegion](../../models/components/createprivateendpointrequestdeclaredregion.mdx)] | :heavy_minus_sign: | Attest where this deployment processes data. | us | +| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `Pricing` | [*components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | :heavy_minus_sign: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `ProviderSlug` | `string` | :heavy_check_mark: | Slug of the upstream provider. | azure | +| `UpstreamModelID` | `string` | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/components/createprivateendpointvalidationfailedresponsedata.mdx b/docs/models/components/createprivateendpointvalidationfailedresponsedata.mdx index 62ebef42b..852b33b91 100644 --- a/docs/models/components/createprivateendpointvalidationfailedresponsedata.mdx +++ b/docs/models/components/createprivateendpointvalidationfailedresponsedata.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseData" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Endpoint` | [components.ManagedPrivateEndpoint](../../models/components/managedprivateendpoint.mdx) | ✅ | N/A | -| `Validation` | [*components.PrivateEndpointValidationNullable](../../models/components/privateendpointvalidationnullable.mdx) | ✅ | N/A | \ No newline at end of file +| `Endpoint` | [components.ManagedPrivateEndpoint](../../models/components/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | +| `Validation` | [*components.PrivateEndpointValidationNullable](../../models/components/privateendpointvalidationnullable.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createprivateendpointvalidationfailedresponseerror.mdx b/docs/models/components/createprivateendpointvalidationfailedresponseerror.mdx index ea13a95ac..8c723288f 100644 --- a/docs/models/components/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/models/components/createprivateendpointvalidationfailedresponseerror.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createscimgroupmappingrequest.mdx b/docs/models/components/createscimgroupmappingrequest.mdx index bf680f52f..42cb64559 100644 --- a/docs/models/components/createscimgroupmappingrequest.mdx +++ b/docs/models/components/createscimgroupmappingrequest.mdx @@ -6,6 +6,6 @@ title: "CreateScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Role` | [components.CreateScimGroupMappingRequestRole](../../models/components/createscimgroupmappingrequestrole.mdx) | ✅ | N/A | -| `ScimGroupID` | `string` | ✅ | N/A | -| `WorkspaceID` | `string` | ✅ | N/A | \ No newline at end of file +| `Role` | [components.CreateScimGroupMappingRequestRole](../../models/components/createscimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | +| `ScimGroupID` | `string` | :heavy_check_mark: | N/A | +| `WorkspaceID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createscimgroupmappingresponse.mdx b/docs/models/components/createscimgroupmappingresponse.mdx index 61334a1ee..9440c95d4 100644 --- a/docs/models/components/createscimgroupmappingresponse.mdx +++ b/docs/models/components/createscimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "CreateScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/createscimsyncjobresponse.mdx b/docs/models/components/createscimsyncjobresponse.mdx index 5dd0e6f6d..81504d827 100644 --- a/docs/models/components/createscimsyncjobresponse.mdx +++ b/docs/models/components/createscimsyncjobresponse.mdx @@ -6,4 +6,4 @@ title: "CreateScimSyncJobResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Data` | [components.ScimSyncJob](../../models/components/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.ScimSyncJob](../../models/components/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createworkspacerequest.mdx b/docs/models/components/createworkspacerequest.mdx index 4238549a3..36a87f5b6 100644 --- a/docs/models/components/createworkspacerequest.mdx +++ b/docs/models/components/createworkspacerequest.mdx @@ -6,15 +6,15 @@ title: "CreateWorkspaceRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Default text model for this workspace | openai/gpt-4o | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | Description of the workspace | Production environment workspace | -| `DisabledServerTools` | optionalnullable.OptionalNullable[[][components.CreateWorkspaceRequestDisabledServerTool](../../models/components/createworkspacerequestdisabledservertool.mdx)] | ➖ | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | -| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | ➖ | Optional array of API key IDs to filter I/O logging | null | -| `IoLoggingSamplingRate` | `*float64` | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | -| `IsDataDiscountLoggingEnabled` | `*bool` | ➖ | Whether data discount logging is enabled | true | -| `IsObservabilityBroadcastEnabled` | `*bool` | ➖ | Whether broadcast is enabled | false | -| `IsObservabilityIoLoggingEnabled` | `*bool` | ➖ | Whether private logging is enabled | false | -| `Name` | `string` | ✅ | Name for the new workspace | Production | -| `Slug` | `string` | ✅ | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file +| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | +| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | +| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the workspace | Production environment workspace | +| `DisabledServerTools` | optionalnullable.OptionalNullable[[][components.CreateWorkspaceRequestDisabledServerTool](../../models/components/createworkspacerequestdisabledservertool.mdx)] | :heavy_minus_sign: | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | +| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | +| `IoLoggingSamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | +| `IsDataDiscountLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether data discount logging is enabled | true | +| `IsObservabilityBroadcastEnabled` | `*bool` | :heavy_minus_sign: | Whether broadcast is enabled | false | +| `IsObservabilityIoLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether private logging is enabled | false | +| `Name` | `string` | :heavy_check_mark: | Name for the new workspace | Production | +| `Slug` | `string` | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file diff --git a/docs/models/components/createworkspaceresponse.mdx b/docs/models/components/createworkspaceresponse.mdx index 8806285c0..390c1ae20 100644 --- a/docs/models/components/createworkspaceresponse.mdx +++ b/docs/models/components/createworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "CreateWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `Data` | [components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/components/customtool.mdx b/docs/models/components/customtool.mdx index 78ac9400e..e8bf8dc67 100644 --- a/docs/models/components/customtool.mdx +++ b/docs/models/components/customtool.mdx @@ -9,8 +9,8 @@ Custom tool configuration | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `Description` | `*string` | ➖ | N/A | | -| `Format` | [*components.Format](../../models/components/format.mdx) | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Type` | [components.CustomToolTypeCustom](../../models/components/customtooltypecustom.mdx) | ✅ | N/A | | \ No newline at end of file +| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `Description` | `*string` | :heavy_minus_sign: | N/A | | +| `Format` | [*components.Format](../../models/components/format.mdx) | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.CustomToolTypeCustom](../../models/components/customtooltypecustom.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/customtoolcallinputdeltaevent.mdx b/docs/models/components/customtoolcallinputdeltaevent.mdx index 1e60870dd..487e53971 100644 --- a/docs/models/components/customtoolcallinputdeltaevent.mdx +++ b/docs/models/components/customtoolcallinputdeltaevent.mdx @@ -9,8 +9,8 @@ Event emitted when a custom tool call's freeform input is being streamed. Mirror | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.CustomToolCallInputDeltaEventType](../../models/components/customtoolcallinputdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.CustomToolCallInputDeltaEventType](../../models/components/customtoolcallinputdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcallinputdoneevent.mdx b/docs/models/components/customtoolcallinputdoneevent.mdx index 8d359288a..dac6d4d87 100644 --- a/docs/models/components/customtoolcallinputdoneevent.mdx +++ b/docs/models/components/customtoolcallinputdoneevent.mdx @@ -9,8 +9,8 @@ Event emitted when a custom tool call's freeform input streaming is complete. Mi | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Input` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.CustomToolCallInputDoneEventType](../../models/components/customtoolcallinputdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Input` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.CustomToolCallInputDoneEventType](../../models/components/customtoolcallinputdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcallitem.mdx b/docs/models/components/customtoolcallitem.mdx index d612becd2..c67b023fb 100644 --- a/docs/models/components/customtoolcallitem.mdx +++ b/docs/models/components/customtoolcallitem.mdx @@ -9,11 +9,11 @@ A call to a custom (freeform-grammar) tool created by the model — distinct fro | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Async` | optionalnullable.OptionalNullable[`bool`] | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Input` | `string` | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Namespace` | optionalnullable.OptionalNullable[`string`] | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | -| `Type` | [components.CustomToolCallItemType](../../models/components/customtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Async` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Input` | `string` | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Namespace` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.CustomToolCallItemType](../../models/components/customtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/customtoolcalloutputitem.mdx b/docs/models/components/customtoolcalloutputitem.mdx index 10f36104e..7ec0b9d38 100644 --- a/docs/models/components/customtoolcalloutputitem.mdx +++ b/docs/models/components/customtoolcalloutputitem.mdx @@ -9,7 +9,7 @@ The output from a custom (freeform-grammar) tool call execution. Mirrors `functi | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `CallID` | `string` | ✅ | N/A | -| `ID` | `*string` | ➖ | N/A | -| `Output` | [components.CustomToolCallOutputItemOutputUnion2](../../models/components/customtoolcalloutputitemoutputunion2.mdx) | ✅ | N/A | -| `Type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../../models/components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | ✅ | N/A | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | +| `ID` | `*string` | :heavy_minus_sign: | N/A | +| `Output` | [components.CustomToolCallOutputItemOutputUnion2](../../models/components/customtoolcalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../../models/components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx b/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx index 9e8c8427c..4055f686d 100644 --- a/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx +++ b/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Detail` | [components.CustomToolCallOutputItemDetail](../../models/components/customtoolcalloutputitemdetail.mdx) | ✅ | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.CustomToolCallOutputItemOutputType](../../models/components/customtoolcalloutputitemoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Detail` | [components.CustomToolCallOutputItemDetail](../../models/components/customtoolcalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.CustomToolCallOutputItemOutputType](../../models/components/customtoolcalloutputitemoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/dabenchmarkentry.mdx b/docs/models/components/dabenchmarkentry.mdx index f99928c48..c95852f49 100644 --- a/docs/models/components/dabenchmarkentry.mdx +++ b/docs/models/components/dabenchmarkentry.mdx @@ -9,8 +9,8 @@ A single Design Arena benchmark entry for a specific arena+category | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Arena` | `string` | ✅ | Arena type (e.g. models, builders, agents) | models | -| `Category` | `string` | ✅ | Category within the arena (e.g. website, gamedev, uicomponent) | website | -| `Elo` | `float64` | ✅ | ELO rating from head-to-head arena battles | 1385.2 | -| `Rank` | `int64` | ✅ | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | -| `WinRate` | `float64` | ✅ | Win rate percentage in arena battles | 62.5 | \ No newline at end of file +| `Arena` | `string` | :heavy_check_mark: | Arena type (e.g. models, builders, agents) | models | +| `Category` | `string` | :heavy_check_mark: | Category within the arena (e.g. website, gamedev, uicomponent) | website | +| `Elo` | `float64` | :heavy_check_mark: | ELO rating from head-to-head arena battles | 1385.2 | +| `Rank` | `int64` | :heavy_check_mark: | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | +| `WinRate` | `float64` | :heavy_check_mark: | Win rate percentage in arena battles | 62.5 | \ No newline at end of file diff --git a/docs/models/components/datetimeservertool.mdx b/docs/models/components/datetimeservertool.mdx index 8e2ab49cd..221fe0940 100644 --- a/docs/models/components/datetimeservertool.mdx +++ b/docs/models/components/datetimeservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: returns the current date and time | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.DatetimeServerToolConfig](../../models/components/datetimeservertoolconfig.mdx) | ➖ | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | -| `Type` | [components.DatetimeServerToolType](../../models/components/datetimeservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.DatetimeServerToolConfig](../../models/components/datetimeservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | +| `Type` | [components.DatetimeServerToolType](../../models/components/datetimeservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/datetimeservertoolconfig.mdx b/docs/models/components/datetimeservertoolconfig.mdx index aa411f8fd..afcc032a2 100644 --- a/docs/models/components/datetimeservertoolconfig.mdx +++ b/docs/models/components/datetimeservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:datetime server tool | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Timezone` | `*string` | ➖ | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file +| `Timezone` | `*string` | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file diff --git a/docs/models/components/debugevent.mdx b/docs/models/components/debugevent.mdx index 95ed0a23e..e2ceb694d 100644 --- a/docs/models/components/debugevent.mdx +++ b/docs/models/components/debugevent.mdx @@ -9,6 +9,6 @@ Debug event emitted when debug.echo_upstream_body is true. Contains the transfor | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Debug` | [components.DebugEventDebug](../../models/components/debugeventdebug.mdx) | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.DebugEventType](../../models/components/debugeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Debug` | [components.DebugEventDebug](../../models/components/debugeventdebug.mdx) | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.DebugEventType](../../models/components/debugeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/debugeventdebug.mdx b/docs/models/components/debugeventdebug.mdx index 1ad9be38d..9df19ec9a 100644 --- a/docs/models/components/debugeventdebug.mdx +++ b/docs/models/components/debugeventdebug.mdx @@ -6,5 +6,5 @@ title: "DebugEventDebug" | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `EchoUpstreamBody` | map[string]`any` | ➖ | N/A | -| `Timings` | [*components.DebugEventTimings](../../models/components/debugeventtimings.mdx) | ➖ | N/A | \ No newline at end of file +| `EchoUpstreamBody` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Timings` | [*components.DebugEventTimings](../../models/components/debugeventtimings.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/debugeventtimings.mdx b/docs/models/components/debugeventtimings.mdx index 6dddd22b8..c925054ae 100644 --- a/docs/models/components/debugeventtimings.mdx +++ b/docs/models/components/debugeventtimings.mdx @@ -6,6 +6,6 @@ title: "DebugEventTimings" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `EpochMs` | `int64` | ✅ | N/A | -| `Event` | [components.DebugEventEvent](../../models/components/debugeventevent.mdx) | ✅ | N/A | -| `StartMs` | `int64` | ✅ | N/A | \ No newline at end of file +| `EpochMs` | `int64` | :heavy_check_mark: | N/A | +| `Event` | [components.DebugEventEvent](../../models/components/debugeventevent.mdx) | :heavy_check_mark: | N/A | +| `StartMs` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/decisions.mdx b/docs/models/components/decisions.mdx index 93156b90f..72fd4efa3 100644 --- a/docs/models/components/decisions.mdx +++ b/docs/models/components/decisions.mdx @@ -6,6 +6,6 @@ title: "Decisions" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/decisionschoiceanswer.mdx b/docs/models/components/decisionschoiceanswer.mdx index cb067ff54..0b8964ab3 100644 --- a/docs/models/components/decisionschoiceanswer.mdx +++ b/docs/models/components/decisionschoiceanswer.mdx @@ -6,7 +6,7 @@ title: "DecisionsChoiceAnswer" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Choice` | `string` | ✅ | N/A | -| `Confidence` | `*float64` | ➖ | N/A | -| `Probabilities` | map[string]`float64` | ➖ | N/A | -| `Type` | [components.DecisionsChoiceAnswerType](../../models/components/decisionschoiceanswertype.mdx) | ✅ | N/A | \ No newline at end of file +| `Choice` | `string` | :heavy_check_mark: | N/A | +| `Confidence` | `*float64` | :heavy_minus_sign: | N/A | +| `Probabilities` | map[string]`float64` | :heavy_minus_sign: | N/A | +| `Type` | [components.DecisionsChoiceAnswerType](../../models/components/decisionschoiceanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionschoicequestion.mdx b/docs/models/components/decisionschoicequestion.mdx index c894f9bf4..cd83cdf6c 100644 --- a/docs/models/components/decisionschoicequestion.mdx +++ b/docs/models/components/decisionschoicequestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsChoiceQuestion" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Criteria` | map[string][*components.Criteria](../../models/components/criteria.mdx) | ✅ | N/A | -| `Instructions` | [components.DecisionsChoiceQuestionInstructions](../../models/components/decisionschoicequestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | -| `Type` | [components.DecisionsChoiceQuestionType](../../models/components/decisionschoicequestiontype.mdx) | ✅ | N/A | \ No newline at end of file +| `Criteria` | map[string][*components.Criteria](../../models/components/criteria.mdx) | :heavy_check_mark: | N/A | +| `Instructions` | [components.DecisionsChoiceQuestionInstructions](../../models/components/decisionschoicequestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | +| `Type` | [components.DecisionsChoiceQuestionType](../../models/components/decisionschoicequestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsnoulanswer.mdx b/docs/models/components/decisionsnoulanswer.mdx index d644c3709..3aea0c5c2 100644 --- a/docs/models/components/decisionsnoulanswer.mdx +++ b/docs/models/components/decisionsnoulanswer.mdx @@ -6,5 +6,5 @@ title: "DecisionsNoulAnswer" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Noul` | `float64` | ✅ | N/A | -| `Type` | [components.DecisionsNoulAnswerType](../../models/components/decisionsnoulanswertype.mdx) | ✅ | N/A | \ No newline at end of file +| `Noul` | `float64` | :heavy_check_mark: | N/A | +| `Type` | [components.DecisionsNoulAnswerType](../../models/components/decisionsnoulanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsnoulquestion.mdx b/docs/models/components/decisionsnoulquestion.mdx index fcaafca54..3566d9cc5 100644 --- a/docs/models/components/decisionsnoulquestion.mdx +++ b/docs/models/components/decisionsnoulquestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsNoulQuestion" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Criteria` | [*components.DecisionsNoulQuestionCriteria](../../models/components/decisionsnoulquestioncriteria.mdx) | ➖ | N/A | -| `Instructions` | [components.DecisionsNoulQuestionInstructions](../../models/components/decisionsnoulquestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | -| `Type` | [components.DecisionsNoulQuestionType](../../models/components/decisionsnoulquestiontype.mdx) | ✅ | N/A | \ No newline at end of file +| `Criteria` | [*components.DecisionsNoulQuestionCriteria](../../models/components/decisionsnoulquestioncriteria.mdx) | :heavy_minus_sign: | N/A | +| `Instructions` | [components.DecisionsNoulQuestionInstructions](../../models/components/decisionsnoulquestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | +| `Type` | [components.DecisionsNoulQuestionType](../../models/components/decisionsnoulquestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsnoulquestioncriteria.mdx b/docs/models/components/decisionsnoulquestioncriteria.mdx index e479d8a28..891e8365b 100644 --- a/docs/models/components/decisionsnoulquestioncriteria.mdx +++ b/docs/models/components/decisionsnoulquestioncriteria.mdx @@ -6,5 +6,5 @@ title: "DecisionsNoulQuestionCriteria" | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `False` | [components.False](../../models/components/false.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | -| `True` | [components.True](../../models/components/true.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file +| `False` | [components.False](../../models/components/false.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | +| `True` | [components.True](../../models/components/true.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file diff --git a/docs/models/components/decisionsrequest.mdx b/docs/models/components/decisionsrequest.mdx index c24687c92..eb2788da9 100644 --- a/docs/models/components/decisionsrequest.mdx +++ b/docs/models/components/decisionsrequest.mdx @@ -6,10 +6,10 @@ title: "DecisionsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Model` | `string` | ✅ | N/A | | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `Questions` | map[string][components.Questions](../../models/components/questions.mdx) | ✅ | N/A | | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `State` | [components.State](../../models/components/state.mdx) | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `Questions` | map[string][components.Questions](../../models/components/questions.mdx) | :heavy_check_mark: | N/A | | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `State` | [components.State](../../models/components/state.mdx) | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/decisionsresponse.mdx b/docs/models/components/decisionsresponse.mdx index 1c8031767..56c0634a1 100644 --- a/docs/models/components/decisionsresponse.mdx +++ b/docs/models/components/decisionsresponse.mdx @@ -6,8 +6,8 @@ title: "DecisionsResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Answers` | map[string][components.Answers](../../models/components/answers.mdx) | ✅ | N/A | -| `ID` | `*string` | ➖ | N/A | -| `Model` | `string` | ✅ | N/A | -| `Provider` | `*string` | ➖ | N/A | -| `Usage` | [components.DecisionsResponseUsage](../../models/components/decisionsresponseusage.mdx) | ✅ | N/A | \ No newline at end of file +| `Answers` | map[string][components.Answers](../../models/components/answers.mdx) | :heavy_check_mark: | N/A | +| `ID` | `*string` | :heavy_minus_sign: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `Provider` | `*string` | :heavy_minus_sign: | N/A | +| `Usage` | [components.DecisionsResponseUsage](../../models/components/decisionsresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsresponseusage.mdx b/docs/models/components/decisionsresponseusage.mdx index 1a9779095..c5f773737 100644 --- a/docs/models/components/decisionsresponseusage.mdx +++ b/docs/models/components/decisionsresponseusage.mdx @@ -6,6 +6,6 @@ title: "DecisionsResponseUsage" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Cost` | `*float64` | ➖ | N/A | -| `InputTokens` | `int64` | ✅ | N/A | -| `OutputTokens` | `int64` | ✅ | N/A | \ No newline at end of file +| `Cost` | `*float64` | :heavy_minus_sign: | N/A | +| `InputTokens` | `int64` | :heavy_check_mark: | N/A | +| `OutputTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsscoreanswer.mdx b/docs/models/components/decisionsscoreanswer.mdx index dc4337ab7..b99f15142 100644 --- a/docs/models/components/decisionsscoreanswer.mdx +++ b/docs/models/components/decisionsscoreanswer.mdx @@ -6,8 +6,8 @@ title: "DecisionsScoreAnswer" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Confidence` | `*float64` | ➖ | N/A | -| `Legend` | map[string][components.Legend](../../models/components/legend.mdx) | ➖ | N/A | -| `Probabilities` | map[string]`float64` | ➖ | N/A | -| `Score` | `float64` | ✅ | N/A | -| `Type` | [components.DecisionsScoreAnswerType](../../models/components/decisionsscoreanswertype.mdx) | ✅ | N/A | \ No newline at end of file +| `Confidence` | `*float64` | :heavy_minus_sign: | N/A | +| `Legend` | map[string][components.Legend](../../models/components/legend.mdx) | :heavy_minus_sign: | N/A | +| `Probabilities` | map[string]`float64` | :heavy_minus_sign: | N/A | +| `Score` | `float64` | :heavy_check_mark: | N/A | +| `Type` | [components.DecisionsScoreAnswerType](../../models/components/decisionsscoreanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsscorequestion.mdx b/docs/models/components/decisionsscorequestion.mdx index 92d2c0227..327538fd2 100644 --- a/docs/models/components/decisionsscorequestion.mdx +++ b/docs/models/components/decisionsscorequestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsScoreQuestion" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Criteria` | [][components.Criterion](../../models/components/criterion.mdx) | ✅ | N/A | -| `Instructions` | [components.DecisionsScoreQuestionInstructions](../../models/components/decisionsscorequestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | -| `Type` | [components.DecisionsScoreQuestionType](../../models/components/decisionsscorequestiontype.mdx) | ✅ | N/A | \ No newline at end of file +| `Criteria` | [][components.Criterion](../../models/components/criterion.mdx) | :heavy_check_mark: | N/A | +| `Instructions` | [components.DecisionsScoreQuestionInstructions](../../models/components/decisionsscorequestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | +| `Type` | [components.DecisionsScoreQuestionType](../../models/components/decisionsscorequestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/defaultparameters.mdx b/docs/models/components/defaultparameters.mdx index 97cbacfaa..e6ddbdebf 100644 --- a/docs/models/components/defaultparameters.mdx +++ b/docs/models/components/defaultparameters.mdx @@ -9,9 +9,9 @@ Default parameters for this model | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | -| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | -| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | -| `Temperature` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | -| `TopK` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | -| `TopP` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | \ No newline at end of file +| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | +| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | +| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | +| `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | +| `TopK` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | +| `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/deletebyokkeyresponse.mdx b/docs/models/components/deletebyokkeyresponse.mdx index 77b479ff2..a658459f3 100644 --- a/docs/models/components/deletebyokkeyresponse.mdx +++ b/docs/models/components/deletebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Deleted` | `bool` | ✅ | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file +| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file diff --git a/docs/models/components/deleteguardrailresponse.mdx b/docs/models/components/deleteguardrailresponse.mdx index 89d0213ed..ee9b0e2bb 100644 --- a/docs/models/components/deleteguardrailresponse.mdx +++ b/docs/models/components/deleteguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteGuardrailResponse" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Deleted` | `bool` | ✅ | Confirmation that the guardrail was deleted | true | \ No newline at end of file +| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/docs/models/components/deleteinternrequest.mdx b/docs/models/components/deleteinternrequest.mdx index d768aac32..b2691a0d5 100644 --- a/docs/models/components/deleteinternrequest.mdx +++ b/docs/models/components/deleteinternrequest.mdx @@ -9,4 +9,4 @@ Optional consent for a teardown that discards the workspace. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `AcknowledgeWorkspaceLoss` | `*bool` | ➖ | Delete even though the workspace backup was not confirmed. Defaults to false, which refuses the teardown when a workspace archive is missing. | \ No newline at end of file +| `AcknowledgeWorkspaceLoss` | `*bool` | :heavy_minus_sign: | Delete even though the workspace backup was not confirmed. Defaults to false, which refuses the teardown when a workspace archive is missing. | \ No newline at end of file diff --git a/docs/models/components/deleteinternresponse.mdx b/docs/models/components/deleteinternresponse.mdx index b2c5be667..2d09b36db 100644 --- a/docs/models/components/deleteinternresponse.mdx +++ b/docs/models/components/deleteinternresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Deleting` | `bool` | ✅ | N/A | \ No newline at end of file +| `Deleting` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/deleteobservabilitydestinationresponse.mdx b/docs/models/components/deleteobservabilitydestinationresponse.mdx index f9ccc0664..70b0298e4 100644 --- a/docs/models/components/deleteobservabilitydestinationresponse.mdx +++ b/docs/models/components/deleteobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteObservabilityDestinationResponse" | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `Deleted` | `bool` | ✅ | Always `true` on success. | \ No newline at end of file +| `Deleted` | `bool` | :heavy_check_mark: | Always `true` on success. | \ No newline at end of file diff --git a/docs/models/components/deleteprivateendpointresponse.mdx b/docs/models/components/deleteprivateendpointresponse.mdx index 2d90617f0..de6692d25 100644 --- a/docs/models/components/deleteprivateendpointresponse.mdx +++ b/docs/models/components/deleteprivateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "DeletePrivateEndpointResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.DeletePrivateEndpointResponseData](../../models/components/deleteprivateendpointresponsedata.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.DeletePrivateEndpointResponseData](../../models/components/deleteprivateendpointresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/deleteprivateendpointresponsedata.mdx b/docs/models/components/deleteprivateendpointresponsedata.mdx index 30b1e6f79..71baa8231 100644 --- a/docs/models/components/deleteprivateendpointresponsedata.mdx +++ b/docs/models/components/deleteprivateendpointresponsedata.mdx @@ -6,4 +6,4 @@ title: "DeletePrivateEndpointResponseData" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/components/deletescimgroupmappingresponse.mdx b/docs/models/components/deletescimgroupmappingresponse.mdx index 17491daf5..2e155cc07 100644 --- a/docs/models/components/deletescimgroupmappingresponse.mdx +++ b/docs/models/components/deletescimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteScimGroupMappingResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Deleted` | `bool` | ✅ | N/A | \ No newline at end of file +| `Deleted` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/deleteworkspacebudgetresponse.mdx b/docs/models/components/deleteworkspacebudgetresponse.mdx index 3bc166739..1bdca53e3 100644 --- a/docs/models/components/deleteworkspacebudgetresponse.mdx +++ b/docs/models/components/deleteworkspacebudgetresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `Deleted` | `bool` | ✅ | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file +| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file diff --git a/docs/models/components/deleteworkspaceresponse.mdx b/docs/models/components/deleteworkspaceresponse.mdx index a9c812cdb..895665447 100644 --- a/docs/models/components/deleteworkspaceresponse.mdx +++ b/docs/models/components/deleteworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteWorkspaceResponse" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Deleted` | `bool` | ✅ | Confirmation that the workspace was deleted | true | \ No newline at end of file +| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the workspace was deleted | true | \ No newline at end of file diff --git a/docs/models/components/easyinputmessage.mdx b/docs/models/components/easyinputmessage.mdx index 6d8ba22a6..736d5df2e 100644 --- a/docs/models/components/easyinputmessage.mdx +++ b/docs/models/components/easyinputmessage.mdx @@ -6,7 +6,7 @@ title: "EasyInputMessage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[components.EasyInputMessageContentUnion2](../../models/components/easyinputmessagecontentunion2.mdx)] | ➖ | N/A | | -| `Phase` | optionalnullable.OptionalNullable[[components.EasyInputMessagePhaseUnion](../../models/components/easyinputmessagephaseunion.mdx)] | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer | -| `Role` | [components.EasyInputMessageRoleUnion](../../models/components/easyinputmessageroleunion.mdx) | ✅ | N/A | | -| `Type` | [*components.EasyInputMessageTypeMessage](../../models/components/easyinputmessagetypemessage.mdx) | ➖ | N/A | | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[components.EasyInputMessageContentUnion2](../../models/components/easyinputmessagecontentunion2.mdx)] | :heavy_minus_sign: | N/A | | +| `Phase` | optionalnullable.OptionalNullable[[components.EasyInputMessagePhaseUnion](../../models/components/easyinputmessagephaseunion.mdx)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer | +| `Role` | [components.EasyInputMessageRoleUnion](../../models/components/easyinputmessageroleunion.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [*components.EasyInputMessageTypeMessage](../../models/components/easyinputmessagetypemessage.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/easyinputmessagecontentinputimage.mdx b/docs/models/components/easyinputmessagecontentinputimage.mdx index bf042ea8f..044ea66d3 100644 --- a/docs/models/components/easyinputmessagecontentinputimage.mdx +++ b/docs/models/components/easyinputmessagecontentinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.EasyInputMessageDetail](../../models/components/easyinputmessagedetail.mdx) | ✅ | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.EasyInputMessageTypeInputImage](../../models/components/easyinputmessagetypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file +| `Detail` | [components.EasyInputMessageDetail](../../models/components/easyinputmessagedetail.mdx) | :heavy_check_mark: | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.EasyInputMessageTypeInputImage](../../models/components/easyinputmessagetypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/edgenetworktimeoutresponseerrordata.mdx b/docs/models/components/edgenetworktimeoutresponseerrordata.mdx index d3c21a9a2..6039582e7 100644 --- a/docs/models/components/edgenetworktimeoutresponseerrordata.mdx +++ b/docs/models/components/edgenetworktimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for EdgeNetworkTimeoutResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/editclearthinking20251015.mdx b/docs/models/components/editclearthinking20251015.mdx index 9b1d54f87..fe22b8b8c 100644 --- a/docs/models/components/editclearthinking20251015.mdx +++ b/docs/models/components/editclearthinking20251015.mdx @@ -6,5 +6,5 @@ title: "EditClearThinking20251015" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Keep` | [*components.Keep](../../models/components/keep.mdx) | ➖ | N/A | -| `Type` | [components.TypeClearThinking20251015](../../models/components/typeclearthinking20251015.mdx) | ✅ | N/A | \ No newline at end of file +| `Keep` | [*components.Keep](../../models/components/keep.mdx) | :heavy_minus_sign: | N/A | +| `Type` | [components.TypeClearThinking20251015](../../models/components/typeclearthinking20251015.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/editcleartooluses20250919.mdx b/docs/models/components/editcleartooluses20250919.mdx index 9d615885c..c91abc41e 100644 --- a/docs/models/components/editcleartooluses20250919.mdx +++ b/docs/models/components/editcleartooluses20250919.mdx @@ -6,9 +6,9 @@ title: "EditClearToolUses20250919" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClearAtLeast` | optionalnullable.OptionalNullable[[components.AnthropicInputTokensClearAtLeast](../../models/components/anthropicinputtokensclearatleast.mdx)] | ➖ | N/A | \{
"type": "input_tokens",
"value": 50000
} | -| `ClearToolInputs` | optionalnullable.OptionalNullable[[components.ClearToolInputs](../../models/components/cleartoolinputs.mdx)] | ➖ | N/A | | -| `ExcludeTools` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | -| `Keep` | [*components.AnthropicToolUsesKeep](../../models/components/anthropictooluseskeep.mdx) | ➖ | N/A | \{
"type": "tool_uses",
"value": 5
} | -| `Trigger` | [*components.Trigger](../../models/components/trigger.mdx) | ➖ | N/A | | -| `Type` | [components.TypeClearToolUses20250919](../../models/components/typecleartooluses20250919.mdx) | ✅ | N/A | | \ No newline at end of file +| `ClearAtLeast` | optionalnullable.OptionalNullable[[components.AnthropicInputTokensClearAtLeast](../../models/components/anthropicinputtokensclearatleast.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | +| `ClearToolInputs` | optionalnullable.OptionalNullable[[components.ClearToolInputs](../../models/components/cleartoolinputs.mdx)] | :heavy_minus_sign: | N/A | | +| `ExcludeTools` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | +| `Keep` | [*components.AnthropicToolUsesKeep](../../models/components/anthropictooluseskeep.mdx) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | +| `Trigger` | [*components.Trigger](../../models/components/trigger.mdx) | :heavy_minus_sign: | N/A | | +| `Type` | [components.TypeClearToolUses20250919](../../models/components/typecleartooluses20250919.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/editcompact20260112.mdx b/docs/models/components/editcompact20260112.mdx index 8cb493fb9..c294056ba 100644 --- a/docs/models/components/editcompact20260112.mdx +++ b/docs/models/components/editcompact20260112.mdx @@ -6,7 +6,7 @@ title: "EditCompact20260112" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `PauseAfterCompaction` | `*bool` | ➖ | N/A | | -| `Trigger` | optionalnullable.OptionalNullable[[components.TriggerInputTokens](../../models/components/triggerinputtokens.mdx)] | ➖ | N/A | \{
"type": "input_tokens",
"value": 100000
} | -| `Type` | [components.TypeCompact20260112](../../models/components/typecompact20260112.mdx) | ✅ | N/A | | \ No newline at end of file +| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `PauseAfterCompaction` | `*bool` | :heavy_minus_sign: | N/A | | +| `Trigger` | optionalnullable.OptionalNullable[[components.TriggerInputTokens](../../models/components/triggerinputtokens.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | +| `Type` | [components.TypeCompact20260112](../../models/components/typecompact20260112.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/embeddings.mdx b/docs/models/components/embeddings.mdx index 6410696de..9ab5f3958 100644 --- a/docs/models/components/embeddings.mdx +++ b/docs/models/components/embeddings.mdx @@ -6,6 +6,6 @@ title: "Embeddings" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/endpointinfo.mdx b/docs/models/components/endpointinfo.mdx index 2e807e4d1..f3a2d1c25 100644 --- a/docs/models/components/endpointinfo.mdx +++ b/docs/models/components/endpointinfo.mdx @@ -6,6 +6,6 @@ title: "EndpointInfo" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | ✅ | N/A | -| `Provider` | `string` | ✅ | N/A | -| `Selected` | `bool` | ✅ | N/A | \ No newline at end of file +| `Model` | `string` | :heavy_check_mark: | N/A | +| `Provider` | `string` | :heavy_check_mark: | N/A | +| `Selected` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/endpointsmetadata.mdx b/docs/models/components/endpointsmetadata.mdx index 99b5beaab..68adcf3d8 100644 --- a/docs/models/components/endpointsmetadata.mdx +++ b/docs/models/components/endpointsmetadata.mdx @@ -6,5 +6,5 @@ title: "EndpointsMetadata" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Available` | [][components.EndpointInfo](../../models/components/endpointinfo.mdx) | ✅ | N/A | -| `Total` | `int64` | ✅ | N/A | \ No newline at end of file +| `Available` | [][components.EndpointInfo](../../models/components/endpointinfo.mdx) | :heavy_check_mark: | N/A | +| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/enduser.mdx b/docs/models/components/enduser.mdx index 03feccf03..9dfecf17b 100644 --- a/docs/models/components/enduser.mdx +++ b/docs/models/components/enduser.mdx @@ -4,9 +4,9 @@ title: "EndUser" ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | Registration creation time. | 2026-09-16T12:00:00Z | -| `IsActive` | `bool` | ✅ | Whether this registration is active. Not an inference authorization decision. | true | -| `UpdatedAt` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | -| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | Registration creation time. | 2026-09-16T12:00:00Z | +| `IsActive` | `bool` | :heavy_check_mark: | Whether this registration is active. Not an inference authorization decision. | true | +| `UpdatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | +| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file diff --git a/docs/models/components/enduserresponse.mdx b/docs/models/components/enduserresponse.mdx index dd92c1729..cdc42980f 100644 --- a/docs/models/components/enduserresponse.mdx +++ b/docs/models/components/enduserresponse.mdx @@ -6,4 +6,4 @@ title: "EndUserResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.EndUser](../../models/components/enduser.mdx) | ✅ | N/A | \{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
} | \ No newline at end of file +| `Data` | [components.EndUser](../../models/components/enduser.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
} | \ No newline at end of file diff --git a/docs/models/components/enumcapability.mdx b/docs/models/components/enumcapability.mdx index 11432f782..8948f3874 100644 --- a/docs/models/components/enumcapability.mdx +++ b/docs/models/components/enumcapability.mdx @@ -9,5 +9,5 @@ A parameter that accepts one of a discrete set of string values. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Type` | [components.EnumCapabilityType](../../models/components/enumcapabilitytype.mdx) | ✅ | N/A | -| `Values` | []`string` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.EnumCapabilityType](../../models/components/enumcapabilitytype.mdx) | :heavy_check_mark: | N/A | +| `Values` | []`string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/errorevent.mdx b/docs/models/components/errorevent.mdx index 4d0da7226..1d817e45d 100644 --- a/docs/models/components/errorevent.mdx +++ b/docs/models/components/errorevent.mdx @@ -9,8 +9,8 @@ Event emitted when an error occurs during streaming | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Code` | `*string` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Param` | `*string` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ErrorEventType](../../models/components/erroreventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Code` | `*string` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Param` | `*string` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ErrorEventType](../../models/components/erroreventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/failedmodel.mdx b/docs/models/components/failedmodel.mdx index b83d615bc..0913c63d2 100644 --- a/docs/models/components/failedmodel.mdx +++ b/docs/models/components/failedmodel.mdx @@ -6,6 +6,6 @@ title: "FailedModel" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Error` | `string` | ✅ | Error message describing why the model failed. | -| `Model` | `string` | ✅ | Slug of the analysis model that failed. | -| `StatusCode` | `*int64` | ➖ | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file +| `Error` | `string` | :heavy_check_mark: | Error message describing why the model failed. | +| `Model` | `string` | :heavy_check_mark: | Slug of the analysis model that failed. | +| `StatusCode` | `*int64` | :heavy_minus_sign: | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file diff --git a/docs/models/components/filecitation.mdx b/docs/models/components/filecitation.mdx index b58ad1812..94c5664c9 100644 --- a/docs/models/components/filecitation.mdx +++ b/docs/models/components/filecitation.mdx @@ -6,7 +6,7 @@ title: "FileCitation" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `Index` | `int64` | ✅ | N/A | -| `Type` | [components.FileCitationType](../../models/components/filecitationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `Index` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FileCitationType](../../models/components/filecitationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fileparserplugin.mdx b/docs/models/components/fileparserplugin.mdx index 0078bf85c..bc1a76b33 100644 --- a/docs/models/components/fileparserplugin.mdx +++ b/docs/models/components/fileparserplugin.mdx @@ -6,6 +6,6 @@ title: "FileParserPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | ➖ | Set to false to disable the file-parser plugin for this request. Defaults to true. | | -| `ID` | [components.FileParserPluginID](../../models/components/fileparserpluginid.mdx) | ✅ | N/A | | -| `Pdf` | [*components.PDFParserOptions](../../models/components/pdfparseroptions.mdx) | ➖ | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | +| `ID` | [components.FileParserPluginID](../../models/components/fileparserpluginid.mdx) | :heavy_check_mark: | N/A | | +| `Pdf` | [*components.PDFParserOptions](../../models/components/pdfparseroptions.mdx) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file diff --git a/docs/models/components/filepath.mdx b/docs/models/components/filepath.mdx index 7e14886bb..f61c0fca2 100644 --- a/docs/models/components/filepath.mdx +++ b/docs/models/components/filepath.mdx @@ -6,6 +6,6 @@ title: "FilePath" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `FileID` | `string` | ✅ | N/A | -| `Index` | `int64` | ✅ | N/A | -| `Type` | [components.FilePathType](../../models/components/filepathtype.mdx) | ✅ | N/A | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Index` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FilePathType](../../models/components/filepathtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/filesearchservertool.mdx b/docs/models/components/filesearchservertool.mdx index 158840860..43f1d7ae4 100644 --- a/docs/models/components/filesearchservertool.mdx +++ b/docs/models/components/filesearchservertool.mdx @@ -9,8 +9,8 @@ File search tool configuration | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Filters` | optionalnullable.OptionalNullable[[components.FiltersUnion](../../models/components/filtersunion.mdx)] | ➖ | N/A | -| `MaxNumResults` | `*int64` | ➖ | N/A | -| `RankingOptions` | [*components.RankingOptions](../../models/components/rankingoptions.mdx) | ➖ | N/A | -| `Type` | [components.TypeFileSearch](../../models/components/typefilesearch.mdx) | ✅ | N/A | -| `VectorStoreIds` | []`string` | ✅ | N/A | \ No newline at end of file +| `Filters` | optionalnullable.OptionalNullable[[components.FiltersUnion](../../models/components/filtersunion.mdx)] | :heavy_minus_sign: | N/A | +| `MaxNumResults` | `*int64` | :heavy_minus_sign: | N/A | +| `RankingOptions` | [*components.RankingOptions](../../models/components/rankingoptions.mdx) | :heavy_minus_sign: | N/A | +| `Type` | [components.TypeFileSearch](../../models/components/typefilesearch.mdx) | :heavy_check_mark: | N/A | +| `VectorStoreIds` | []`string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/filesservertool.mdx b/docs/models/components/filesservertool.mdx index 2be107981..ab8dab343 100644 --- a/docs/models/components/filesservertool.mdx +++ b/docs/models/components/filesservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: read, write, edit, and list workspace files via | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `Parameters` | [*components.FilesServerToolConfig](../../models/components/filesservertoolconfig.mdx) | ➖ | Configuration for the openrouter:files server tool | \{} | -| `Type` | [components.FilesServerToolType](../../models/components/filesservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.FilesServerToolConfig](../../models/components/filesservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | +| `Type` | [components.FilesServerToolType](../../models/components/filesservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/filters.mdx b/docs/models/components/filters.mdx index 6d8e6aa57..60fea37e5 100644 --- a/docs/models/components/filters.mdx +++ b/docs/models/components/filters.mdx @@ -6,6 +6,6 @@ title: "Filters" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Key` | `string` | ✅ | N/A | -| `Type` | [components.FiltersType](../../models/components/filterstype.mdx) | ✅ | N/A | -| `Value` | [components.FileSearchServerToolValue2](../../models/components/filesearchservertoolvalue2.mdx) | ✅ | N/A | \ No newline at end of file +| `Key` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.FiltersType](../../models/components/filterstype.mdx) | :heavy_check_mark: | N/A | +| `Value` | [components.FileSearchServerToolValue2](../../models/components/filesearchservertoolvalue2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/forbiddenresponseerrordata.mdx b/docs/models/components/forbiddenresponseerrordata.mdx index 0a70f6384..fdd1cee6f 100644 --- a/docs/models/components/forbiddenresponseerrordata.mdx +++ b/docs/models/components/forbiddenresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ForbiddenResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/formatgrammar.mdx b/docs/models/components/formatgrammar.mdx index 3e88803d8..135667ed3 100644 --- a/docs/models/components/formatgrammar.mdx +++ b/docs/models/components/formatgrammar.mdx @@ -6,6 +6,6 @@ title: "FormatGrammar" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Definition` | `string` | ✅ | N/A | -| `Syntax` | [components.Syntax](../../models/components/syntax.mdx) | ✅ | N/A | -| `Type` | [components.FormatTypeGrammar](../../models/components/formattypegrammar.mdx) | ✅ | N/A | \ No newline at end of file +| `Definition` | `string` | :heavy_check_mark: | N/A | +| `Syntax` | [components.Syntax](../../models/components/syntax.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.FormatTypeGrammar](../../models/components/formattypegrammar.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formatjsonobjectconfig.mdx b/docs/models/components/formatjsonobjectconfig.mdx index b0f3e3f45..9c1f2765a 100644 --- a/docs/models/components/formatjsonobjectconfig.mdx +++ b/docs/models/components/formatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.FormatJSONObjectConfigType](../../models/components/formatjsonobjectconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.FormatJSONObjectConfigType](../../models/components/formatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formatjsonschemaconfig.mdx b/docs/models/components/formatjsonschemaconfig.mdx index b7b34d9bc..8fe262e3b 100644 --- a/docs/models/components/formatjsonschemaconfig.mdx +++ b/docs/models/components/formatjsonschemaconfig.mdx @@ -9,8 +9,8 @@ JSON schema constrained response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Description` | `*string` | ➖ | N/A | -| `Name` | `string` | ✅ | N/A | -| `Schema` | map[string]`any` | ✅ | N/A | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | -| `Type` | [components.FormatJSONSchemaConfigType](../../models/components/formatjsonschemaconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Description` | `*string` | :heavy_minus_sign: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | +| `Schema` | map[string]`any` | :heavy_check_mark: | N/A | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | +| `Type` | [components.FormatJSONSchemaConfigType](../../models/components/formatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formattext.mdx b/docs/models/components/formattext.mdx index 247a483e4..0fdb00302 100644 --- a/docs/models/components/formattext.mdx +++ b/docs/models/components/formattext.mdx @@ -6,4 +6,4 @@ title: "FormatText" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Type` | [components.FormatTypeText](../../models/components/formattypetext.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.FormatTypeText](../../models/components/formattypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formattextconfig.mdx b/docs/models/components/formattextconfig.mdx index 8a218ad9c..81c37e82f 100644 --- a/docs/models/components/formattextconfig.mdx +++ b/docs/models/components/formattextconfig.mdx @@ -9,4 +9,4 @@ Plain text response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.FormatTextConfigType](../../models/components/formattextconfigtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.FormatTextConfigType](../../models/components/formattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/frameimage.mdx b/docs/models/components/frameimage.mdx index 1f7890601..daccd1cbb 100644 --- a/docs/models/components/frameimage.mdx +++ b/docs/models/components/frameimage.mdx @@ -6,6 +6,6 @@ title: "FrameImage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ImageURL` | [components.FrameImageImageURL](../../models/components/frameimageimageurl.mdx) | ✅ | N/A | | -| `Type` | [components.FrameImageType](../../models/components/frameimagetype.mdx) | ✅ | N/A | | -| `FrameType` | [components.FrameType](../../models/components/frametype.mdx) | ✅ | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file +| `ImageURL` | [components.FrameImageImageURL](../../models/components/frameimageimageurl.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.FrameImageType](../../models/components/frameimagetype.mdx) | :heavy_check_mark: | N/A | | +| `FrameType` | [components.FrameType](../../models/components/frametype.mdx) | :heavy_check_mark: | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file diff --git a/docs/models/components/frameimageimageurl.mdx b/docs/models/components/frameimageimageurl.mdx index 39cd43de0..8bdba9c99 100644 --- a/docs/models/components/frameimageimageurl.mdx +++ b/docs/models/components/frameimageimageurl.mdx @@ -6,4 +6,4 @@ title: "FrameImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/freemodeldailyrequests.mdx b/docs/models/components/freemodeldailyrequests.mdx index e18912499..f158ace0e 100644 --- a/docs/models/components/freemodeldailyrequests.mdx +++ b/docs/models/components/freemodeldailyrequests.mdx @@ -9,6 +9,6 @@ Free-model (`:free` variant) daily request quota for the account that owns the k | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Limit` | `int64` | ✅ | Free-model requests the account may make per UTC day; the ceiling depends on total credits purchased and is independent of `is_free_tier` | 50 | -| `Remaining` | `int64` | ✅ | Free-model requests left in the current UTC day | 38 | -| `Used` | `int64` | ✅ | Free-model requests recorded for the account so far in the current UTC day | 12 | \ No newline at end of file +| `Limit` | `int64` | :heavy_check_mark: | Free-model requests the account may make per UTC day; the ceiling depends on total credits purchased and is independent of `is_free_tier` | 50 | +| `Remaining` | `int64` | :heavy_check_mark: | Free-model requests left in the current UTC day | 38 | +| `Used` | `int64` | :heavy_check_mark: | Free-model requests recorded for the account so far in the current UTC day | 12 | \ No newline at end of file diff --git a/docs/models/components/functioncallargsdeltaevent.mdx b/docs/models/components/functioncallargsdeltaevent.mdx index ae9f290b9..fe87ef024 100644 --- a/docs/models/components/functioncallargsdeltaevent.mdx +++ b/docs/models/components/functioncallargsdeltaevent.mdx @@ -9,8 +9,8 @@ Event emitted when function call arguments are being streamed | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FunctionCallArgsDeltaEventType](../../models/components/functioncallargsdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FunctionCallArgsDeltaEventType](../../models/components/functioncallargsdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/functioncallargsdoneevent.mdx b/docs/models/components/functioncallargsdoneevent.mdx index d4141284b..73e403d85 100644 --- a/docs/models/components/functioncallargsdoneevent.mdx +++ b/docs/models/components/functioncallargsdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when function call arguments streaming is complete | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FunctionCallArgsDoneEventType](../../models/components/functioncallargsdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FunctionCallArgsDoneEventType](../../models/components/functioncallargsdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/functioncallitem.mdx b/docs/models/components/functioncallitem.mdx index c75b6b7e8..82c411021 100644 --- a/docs/models/components/functioncallitem.mdx +++ b/docs/models/components/functioncallitem.mdx @@ -9,13 +9,13 @@ A function call initiated by the model | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | ✅ | N/A | | -| `Async` | optionalnullable.OptionalNullable[`bool`] | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Namespace` | optionalnullable.OptionalNullable[`string`] | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | -| `SubagentID` | optionalnullable.OptionalNullable[`string`] | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `SubagentItems` | optionalnullable.OptionalNullable[[][components.FunctionCallItemSubagentItem](../../models/components/functioncallitemsubagentitem.mdx)] | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | -| `Type` | [components.FunctionCallItemType](../../models/components/functioncallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | | +| `Async` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Namespace` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | +| `SubagentID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `SubagentItems` | optionalnullable.OptionalNullable[[][components.FunctionCallItemSubagentItem](../../models/components/functioncallitemsubagentitem.mdx)] | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | +| `Type` | [components.FunctionCallItemType](../../models/components/functioncallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/functioncallitemsubagentitem.mdx b/docs/models/components/functioncallitemsubagentitem.mdx index 85a2fc0ac..5df847fde 100644 --- a/docs/models/components/functioncallitemsubagentitem.mdx +++ b/docs/models/components/functioncallitemsubagentitem.mdx @@ -6,5 +6,5 @@ title: "FunctionCallItemSubagentItem" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Type` | `string` | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/functioncalloutputitem.mdx b/docs/models/components/functioncalloutputitem.mdx index 73b3b8ba3..6260074c3 100644 --- a/docs/models/components/functioncalloutputitem.mdx +++ b/docs/models/components/functioncalloutputitem.mdx @@ -9,8 +9,8 @@ The output from a function call execution | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Output` | [components.FunctionCallOutputItemOutputUnion2](../../models/components/functioncalloutputitemoutputunion2.mdx) | ✅ | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | -| `Type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../../models/components/functioncalloutputitemtypefunctioncalloutput.mdx) | ✅ | N/A | | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Output` | [components.FunctionCallOutputItemOutputUnion2](../../models/components/functioncalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../../models/components/functioncalloutputitemtypefunctioncalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/functioncalloutputitemoutputinputimage.mdx b/docs/models/components/functioncalloutputitemoutputinputimage.mdx index 10dd44130..f388a06c7 100644 --- a/docs/models/components/functioncalloutputitemoutputinputimage.mdx +++ b/docs/models/components/functioncalloutputitemoutputinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Detail` | [components.FunctionCallOutputItemDetail](../../models/components/functioncalloutputitemdetail.mdx) | ✅ | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.FunctionCallOutputItemOutputType](../../models/components/functioncalloutputitemoutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Detail` | [components.FunctionCallOutputItemDetail](../../models/components/functioncalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.FunctionCallOutputItemOutputType](../../models/components/functioncalloutputitemoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusionanalysisresult.mdx b/docs/models/components/fusionanalysisresult.mdx index b5434cf01..2b8574ff9 100644 --- a/docs/models/components/fusionanalysisresult.mdx +++ b/docs/models/components/fusionanalysisresult.mdx @@ -9,8 +9,8 @@ Structured analysis produced by the fusion analyst model. | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `BlindSpots` | []`string` | ✅ | N/A | -| `Consensus` | []`string` | ✅ | N/A | -| `Contradictions` | [][components.Contradiction](../../models/components/contradiction.mdx) | ✅ | N/A | -| `PartialCoverage` | [][components.PartialCoverage](../../models/components/partialcoverage.mdx) | ✅ | N/A | -| `UniqueInsights` | [][components.UniqueInsight](../../models/components/uniqueinsight.mdx) | ✅ | N/A | \ No newline at end of file +| `BlindSpots` | []`string` | :heavy_check_mark: | N/A | +| `Consensus` | []`string` | :heavy_check_mark: | N/A | +| `Contradictions` | [][components.Contradiction](../../models/components/contradiction.mdx) | :heavy_check_mark: | N/A | +| `PartialCoverage` | [][components.PartialCoverage](../../models/components/partialcoverage.mdx) | :heavy_check_mark: | N/A | +| `UniqueInsights` | [][components.UniqueInsight](../../models/components/uniqueinsight.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallanalysiscompletedevent.mdx b/docs/models/components/fusioncallanalysiscompletedevent.mdx index 54a4002e4..1bccc6e82 100644 --- a/docs/models/components/fusioncallanalysiscompletedevent.mdx +++ b/docs/models/components/fusioncallanalysiscompletedevent.mdx @@ -9,8 +9,8 @@ Emitted when the fusion analyst completes with the structured analysis. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Analysis` | [components.FusionAnalysisResult](../../models/components/fusionanalysisresult.mdx) | ✅ | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | -| `ItemID` | `string` | ✅ | N/A | | -| `OutputIndex` | `int64` | ✅ | N/A | | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.FusionCallAnalysisCompletedEventType](../../models/components/fusioncallanalysiscompletedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Analysis` | [components.FusionAnalysisResult](../../models/components/fusionanalysisresult.mdx) | :heavy_check_mark: | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | +| `ItemID` | `string` | :heavy_check_mark: | N/A | | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.FusionCallAnalysisCompletedEventType](../../models/components/fusioncallanalysiscompletedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/fusioncallanalysisinprogressevent.mdx b/docs/models/components/fusioncallanalysisinprogressevent.mdx index 6d0ba5a6f..4a41b40fe 100644 --- a/docs/models/components/fusioncallanalysisinprogressevent.mdx +++ b/docs/models/components/fusioncallanalysisinprogressevent.mdx @@ -9,9 +9,9 @@ Emitted when the fusion analyst starts producing the structured analysis. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AnalystModel` | `string` | ✅ | Slug of the model producing the structured analysis. | -| `ItemID` | `string` | ✅ | N/A | -| ~~`JudgeModel`~~ | `string` | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated alias of `analyst_model`, kept so existing consumers keep working. Always carries the same value. Use `analyst_model`. | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FusionCallAnalysisInProgressEventType](../../models/components/fusioncallanalysisinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `AnalystModel` | `string` | :heavy_check_mark: | Slug of the model producing the structured analysis. | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| ~~`JudgeModel`~~ | `string` | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated alias of `analyst_model`, kept so existing consumers keep working. Always carries the same value. Use `analyst_model`. | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FusionCallAnalysisInProgressEventType](../../models/components/fusioncallanalysisinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallcompletedevent.mdx b/docs/models/components/fusioncallcompletedevent.mdx index 21bea64b0..ade9c1d7d 100644 --- a/docs/models/components/fusioncallcompletedevent.mdx +++ b/docs/models/components/fusioncallcompletedevent.mdx @@ -9,7 +9,7 @@ Emitted when the openrouter:fusion tool call finishes. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FusionCallCompletedEventType](../../models/components/fusioncallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FusionCallCompletedEventType](../../models/components/fusioncallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallinprogressevent.mdx b/docs/models/components/fusioncallinprogressevent.mdx index 9b6b28e15..22884b2a1 100644 --- a/docs/models/components/fusioncallinprogressevent.mdx +++ b/docs/models/components/fusioncallinprogressevent.mdx @@ -9,7 +9,7 @@ Emitted when an openrouter:fusion tool call begins executing. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FusionCallInProgressEventType](../../models/components/fusioncallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FusionCallInProgressEventType](../../models/components/fusioncallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpaneladdedevent.mdx b/docs/models/components/fusioncallpaneladdedevent.mdx index 3b00fc790..08d121478 100644 --- a/docs/models/components/fusioncallpaneladdedevent.mdx +++ b/docs/models/components/fusioncallpaneladdedevent.mdx @@ -9,8 +9,8 @@ Emitted when a fusion analysis-panel model starts. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FusionCallPanelAddedEventType](../../models/components/fusioncallpaneladdedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FusionCallPanelAddedEventType](../../models/components/fusioncallpaneladdedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelcompletedevent.mdx b/docs/models/components/fusioncallpanelcompletedevent.mdx index 2018cd9e2..8b41b3677 100644 --- a/docs/models/components/fusioncallpanelcompletedevent.mdx +++ b/docs/models/components/fusioncallpanelcompletedevent.mdx @@ -9,9 +9,9 @@ Emitted when a fusion panel model finishes with its full content. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Content` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FusionCallPanelCompletedEventType](../../models/components/fusioncallpanelcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FusionCallPanelCompletedEventType](../../models/components/fusioncallpanelcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpaneldeltaevent.mdx b/docs/models/components/fusioncallpaneldeltaevent.mdx index fa7d404bf..7bfa29b8f 100644 --- a/docs/models/components/fusioncallpaneldeltaevent.mdx +++ b/docs/models/components/fusioncallpaneldeltaevent.mdx @@ -9,9 +9,9 @@ Incremental content token from a fusion panel model. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FusionCallPanelDeltaEventType](../../models/components/fusioncallpaneldeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FusionCallPanelDeltaEventType](../../models/components/fusioncallpaneldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelfailedevent.mdx b/docs/models/components/fusioncallpanelfailedevent.mdx index 9c985ba28..0c0a45443 100644 --- a/docs/models/components/fusioncallpanelfailedevent.mdx +++ b/docs/models/components/fusioncallpanelfailedevent.mdx @@ -9,10 +9,10 @@ Emitted when a fusion panel model fails. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Error` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `StatusCode` | `*int64` | ➖ | N/A | -| `Type` | [components.FusionCallPanelFailedEventType](../../models/components/fusioncallpanelfailedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Error` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `StatusCode` | `*int64` | :heavy_minus_sign: | N/A | +| `Type` | [components.FusionCallPanelFailedEventType](../../models/components/fusioncallpanelfailedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx b/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx index 361465812..6f9e454fc 100644 --- a/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx +++ b/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx @@ -9,9 +9,9 @@ Incremental reasoning token from a fusion panel model. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.FusionCallPanelReasoningDeltaEventType](../../models/components/fusioncallpanelreasoningdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.FusionCallPanelReasoningDeltaEventType](../../models/components/fusioncallpanelreasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusionplugin.mdx b/docs/models/components/fusionplugin.mdx index 59e1e8bee..cfee02f6c 100644 --- a/docs/models/components/fusionplugin.mdx +++ b/docs/models/components/fusionplugin.mdx @@ -6,10 +6,10 @@ title: "FusionPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AnalysisModels` | []`string` | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, slugs of models to run in parallel as the "expert panel" the analyst analyzes. Each model receives the same user prompt with web_search + web_fetch enabled. Capped at 8 models to bound cost amplification. When omitted, defaults to the Quality preset from the /labs/fusion UI (~anthropic/claude-opus-latest, ~openai/gpt-sol-latest, ~google/gemini-pro-latest). | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | -| `Enabled` | `*bool` | ➖ | Set to false to disable Fusion configuration for a run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. Defaults to true. | | -| `ID` | [components.FusionPluginID](../../models/components/fusionpluginid.mdx) | ✅ | N/A | | -| `MaxToolCalls` | `*int64` | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | -| `Model` | `*string` | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the slug of the model that performs both the analyst step (with web_search + web_fetch) and the final synthesis. When omitted, defaults to the first model in the Quality preset. | ~anthropic/claude-opus-latest | -| `Preset` | [*components.PresetEnum](../../models/components/presetenum.mdx) | ➖ | Configuration for a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. A curated OpenRouter preset (slugs follow `-`, e.g. `general-high`). Expands server-side into the preset's analysis_models panel and analyst model, so callers never name individual models. Explicitly provided `analysis_models` / `model` take precedence. | general-high | -| `Tools` | [][components.FusionPluginTool](../../models/components/fusionplugintool.mdx) | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file +| `AnalysisModels` | []`string` | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, slugs of models to run in parallel as the "expert panel" the analyst analyzes. Each model receives the same user prompt with web_search + web_fetch enabled. Capped at 8 models to bound cost amplification. When omitted, defaults to the Quality preset from the /labs/fusion UI (~anthropic/claude-opus-latest, ~openai/gpt-sol-latest, ~google/gemini-pro-latest). | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | +| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable Fusion configuration for a run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. Defaults to true. | | +| `ID` | [components.FusionPluginID](../../models/components/fusionpluginid.mdx) | :heavy_check_mark: | N/A | | +| `MaxToolCalls` | `*int64` | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | +| `Model` | `*string` | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the slug of the model that performs both the analyst step (with web_search + web_fetch) and the final synthesis. When omitted, defaults to the first model in the Quality preset. | ~anthropic/claude-opus-latest | +| `Preset` | [*components.PresetEnum](../../models/components/presetenum.mdx) | :heavy_minus_sign: | Configuration for a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. A curated OpenRouter preset (slugs follow `-`, e.g. `general-high`). Expands server-side into the preset's analysis_models panel and analyst model, so callers never name individual models. Explicitly provided `analysis_models` / `model` take precedence. | general-high | +| `Tools` | [][components.FusionPluginTool](../../models/components/fusionplugintool.mdx) | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file diff --git a/docs/models/components/fusionplugintool.mdx b/docs/models/components/fusionplugintool.mdx index 63ce10cbb..224921368 100644 --- a/docs/models/components/fusionplugintool.mdx +++ b/docs/models/components/fusionplugintool.mdx @@ -6,5 +6,5 @@ title: "FusionPluginTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `Parameters` | map[string][*components.Parameters3](../../models/components/parameters3.mdx) | ➖ | Optional configuration forwarded as the tool's `parameters` object. | -| `Type` | `string` | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `Parameters` | map[string][*components.Parameters3](../../models/components/parameters3.mdx) | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | +| `Type` | `string` | :heavy_check_mark: | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file diff --git a/docs/models/components/fusionservertoolconfig.mdx b/docs/models/components/fusionservertoolconfig.mdx index a0dd32e9a..53a2ab43c 100644 --- a/docs/models/components/fusionservertoolconfig.mdx +++ b/docs/models/components/fusionservertoolconfig.mdx @@ -9,11 +9,11 @@ Configuration for the openrouter:fusion server tool. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AnalysisModels` | []`string` | ➖ | Slugs of models to run in parallel as the analysis panel. Each model receives the user prompt with openrouter:web_search and openrouter:web_fetch enabled, then an analyst model summarizes the collective output into structured analysis JSON. Capped at 8 models to bound cost amplification. Defaults to the Quality preset from /labs/fusion. | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `MaxCompletionTokens` | `*int64` | ➖ | Maximum number of output tokens (including reasoning tokens) each panelist and the analyst model may produce per inner call. Controls the total output budget so reasoning-heavy models like GPT-5.5 do not exhaust their token allowance before producing visible text. Defaults to 16000 when omitted. | 16384 | -| `MaxToolCalls` | `*int64` | ➖ | Maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | -| `Model` | `*string` | ➖ | Slug of the analyst model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | -| `Reasoning` | [*components.FusionServerToolConfigReasoning](../../models/components/fusionservertoolconfigreasoning.mdx) | ➖ | Reasoning configuration forwarded to panelist and analyst inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | -| `Temperature` | `*float64` | ➖ | Temperature forwarded to panelist inner calls. The analyst always runs at temperature 0 regardless of this value. When omitted, the provider's default applies. | 0.7 | -| `Tools` | [][components.FusionServerToolConfigTool](../../models/components/fusionservertoolconfigtool.mdx) | ➖ | Server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file +| `AnalysisModels` | []`string` | :heavy_minus_sign: | Slugs of models to run in parallel as the analysis panel. Each model receives the user prompt with openrouter:web_search and openrouter:web_fetch enabled, then an analyst model summarizes the collective output into structured analysis JSON. Capped at 8 models to bound cost amplification. Defaults to the Quality preset from /labs/fusion. | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `MaxCompletionTokens` | `*int64` | :heavy_minus_sign: | Maximum number of output tokens (including reasoning tokens) each panelist and the analyst model may produce per inner call. Controls the total output budget so reasoning-heavy models like GPT-5.5 do not exhaust their token allowance before producing visible text. Defaults to 16000 when omitted. | 16384 | +| `MaxToolCalls` | `*int64` | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | +| `Model` | `*string` | :heavy_minus_sign: | Slug of the analyst model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | +| `Reasoning` | [*components.FusionServerToolConfigReasoning](../../models/components/fusionservertoolconfigreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to panelist and analyst inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | +| `Temperature` | `*float64` | :heavy_minus_sign: | Temperature forwarded to panelist inner calls. The analyst always runs at temperature 0 regardless of this value. When omitted, the provider's default applies. | 0.7 | +| `Tools` | [][components.FusionServerToolConfigTool](../../models/components/fusionservertoolconfigtool.mdx) | :heavy_minus_sign: | Server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file diff --git a/docs/models/components/fusionservertoolconfigreasoning.mdx b/docs/models/components/fusionservertoolconfigreasoning.mdx index ce20470f6..5f5a7eed8 100644 --- a/docs/models/components/fusionservertoolconfigreasoning.mdx +++ b/docs/models/components/fusionservertoolconfigreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to panelist and analyst inner calls. Use this | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Effort` | [*components.FusionServerToolConfigEffort](../../models/components/fusionservertoolconfigeffort.mdx) | ➖ | Reasoning effort level for panelist and analyst inner calls. | -| `MaxTokens` | `*int64` | ➖ | Maximum number of reasoning tokens each panelist and analyst model may use. Helps bound cost when models allocate too much budget to chain-of-thought. | \ No newline at end of file +| `Effort` | [*components.FusionServerToolConfigEffort](../../models/components/fusionservertoolconfigeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | +| `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens each panelist and analyst model may use. Helps bound cost when models allocate too much budget to chain-of-thought. | \ No newline at end of file diff --git a/docs/models/components/fusionservertoolconfigtool.mdx b/docs/models/components/fusionservertoolconfigtool.mdx index 6186cce8b..c49d55f54 100644 --- a/docs/models/components/fusionservertoolconfigtool.mdx +++ b/docs/models/components/fusionservertoolconfigtool.mdx @@ -6,5 +6,5 @@ title: "FusionServerToolConfigTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `Parameters` | map[string]`any` | ➖ | Optional configuration forwarded as the tool's `parameters` object. | -| `Type` | `string` | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `Parameters` | map[string]`any` | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | +| `Type` | `string` | :heavy_check_mark: | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file diff --git a/docs/models/components/fusionservertoolopenrouter.mdx b/docs/models/components/fusionservertoolopenrouter.mdx index e3906e7a2..72dc2a84c 100644 --- a/docs/models/components/fusionservertoolopenrouter.mdx +++ b/docs/models/components/fusionservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: fans out the user prompt to a panel of analysis | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.FusionServerToolConfig](../../models/components/fusionservertoolconfig.mdx) | ➖ | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
]
} | -| `Type` | [components.FusionServerToolOpenRouterType](../../models/components/fusionservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.FusionServerToolConfig](../../models/components/fusionservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
]
} | +| `Type` | [components.FusionServerToolOpenRouterType](../../models/components/fusionservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/fusionsource.mdx b/docs/models/components/fusionsource.mdx index 760784e0e..70328a8d9 100644 --- a/docs/models/components/fusionsource.mdx +++ b/docs/models/components/fusionsource.mdx @@ -9,5 +9,5 @@ A web page retrieved via web search during a fusion run. | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Title` | `string` | ✅ | Title of the retrieved web page. | -| `URL` | `string` | ✅ | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file +| `Title` | `string` | :heavy_check_mark: | Title of the retrieved web page. | +| `URL` | `string` | :heavy_check_mark: | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file diff --git a/docs/models/components/gatewaytimeoutresponseerrordata.mdx b/docs/models/components/gatewaytimeoutresponseerrordata.mdx index a3738575a..7e28f3a3f 100644 --- a/docs/models/components/gatewaytimeoutresponseerrordata.mdx +++ b/docs/models/components/gatewaytimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for GatewayTimeoutResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/generationcontentdata.mdx b/docs/models/components/generationcontentdata.mdx index abf86e307..62779e053 100644 --- a/docs/models/components/generationcontentdata.mdx +++ b/docs/models/components/generationcontentdata.mdx @@ -9,6 +9,6 @@ Stored prompt and completion content, plus the failure error when one was stored | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | [*components.GenerationContentError](../../models/components/generationcontenterror.mdx) | ✅ | The stored failure for this generation, or null when it succeeded | \{
"message": "Timed out waiting for the provider",
"previous_errors": [
\{
"code": 429,
"message": "Provider returned error",
"provider_name": "Google",
"raw": "\{\"error\":\{\"code\":429,\"message\":\"Resource exhausted\"}}"
}
],
"provider_name": "Vertex",
"raw": "\{\"error\":\{\"code\":504,\"message\":\"Deadline exceeded\"}}",
"status": 504
} | -| `Input` | [components.InputUnion](../../models/components/inputunion.mdx) | ✅ | The input to the generation — either a prompt string or an array of messages | | -| `Output` | [components.GenerationContentDataOutput](../../models/components/generationcontentdataoutput.mdx) | ✅ | The output from the generation | | \ No newline at end of file +| `Error` | [*components.GenerationContentError](../../models/components/generationcontenterror.mdx) | :heavy_check_mark: | The stored failure for this generation, or null when it succeeded | \{
"message": "Timed out waiting for the provider",
"previous_errors": [
\{
"code": 429,
"message": "Provider returned error",
"provider_name": "Google",
"raw": "\{\"error\":\{\"code\":429,\"message\":\"Resource exhausted\"}}"
}
],
"provider_name": "Vertex",
"raw": "\{\"error\":\{\"code\":504,\"message\":\"Deadline exceeded\"}}",
"status": 504
} | +| `Input` | [components.InputUnion](../../models/components/inputunion.mdx) | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | | +| `Output` | [components.GenerationContentDataOutput](../../models/components/generationcontentdataoutput.mdx) | :heavy_check_mark: | The output from the generation | | \ No newline at end of file diff --git a/docs/models/components/generationcontentdataoutput.mdx b/docs/models/components/generationcontentdataoutput.mdx index 2c33a346a..fedfa624b 100644 --- a/docs/models/components/generationcontentdataoutput.mdx +++ b/docs/models/components/generationcontentdataoutput.mdx @@ -9,5 +9,5 @@ The output from the generation | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Completion` | `*string` | ✅ | The completion output | The meaning of life is a philosophical question... | -| `Reasoning` | `*string` | ✅ | Reasoning/thinking output, if any | null | \ No newline at end of file +| `Completion` | `*string` | :heavy_check_mark: | The completion output | The meaning of life is a philosophical question... | +| `Reasoning` | `*string` | :heavy_check_mark: | Reasoning/thinking output, if any | null | \ No newline at end of file diff --git a/docs/models/components/generationcontenterror.mdx b/docs/models/components/generationcontenterror.mdx index c7af85f36..ee5798da6 100644 --- a/docs/models/components/generationcontenterror.mdx +++ b/docs/models/components/generationcontenterror.mdx @@ -9,8 +9,8 @@ The stored failure for this generation, or null when it succeeded | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Message` | `*string` | ✅ | Error message returned to the client | Timed out waiting for the provider | -| `PreviousErrors` | [][components.GenerationContentErrorAttempt](../../models/components/generationcontenterrorattempt.mdx) | ✅ | Every upstream attempt that failed before the returned error, in attempt order | | -| `ProviderName` | `*string` | ✅ | Provider whose error was returned to the client, when known | Vertex | -| `Raw` | `*string` | ✅ | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | -| `Status` | `*int64` | ✅ | HTTP status returned to the client | 504 | \ No newline at end of file +| `Message` | `*string` | :heavy_check_mark: | Error message returned to the client | Timed out waiting for the provider | +| `PreviousErrors` | [][components.GenerationContentErrorAttempt](../../models/components/generationcontenterrorattempt.mdx) | :heavy_check_mark: | Every upstream attempt that failed before the returned error, in attempt order | | +| `ProviderName` | `*string` | :heavy_check_mark: | Provider whose error was returned to the client, when known | Vertex | +| `Raw` | `*string` | :heavy_check_mark: | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | +| `Status` | `*int64` | :heavy_check_mark: | HTTP status returned to the client | 504 | \ No newline at end of file diff --git a/docs/models/components/generationcontenterrorattempt.mdx b/docs/models/components/generationcontenterrorattempt.mdx index 233ca6468..fab3b45f4 100644 --- a/docs/models/components/generationcontenterrorattempt.mdx +++ b/docs/models/components/generationcontenterrorattempt.mdx @@ -9,7 +9,7 @@ A single failed upstream attempt recorded for the generation | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Code` | `int64` | ✅ | HTTP status returned by this attempt | 429 | -| `Message` | `string` | ✅ | Error message returned by this attempt | Provider returned error | -| `ProviderName` | `*string` | ✅ | Provider that served this attempt, when known | Google | -| `Raw` | `*string` | ✅ | Raw error body returned by the provider, when stored | \{"error":\{"code":429,"message":"Resource exhausted"}} | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | HTTP status returned by this attempt | 429 | +| `Message` | `string` | :heavy_check_mark: | Error message returned by this attempt | Provider returned error | +| `ProviderName` | `*string` | :heavy_check_mark: | Provider that served this attempt, when known | Google | +| `Raw` | `*string` | :heavy_check_mark: | Raw error body returned by the provider, when stored | \{"error":\{"code":429,"message":"Resource exhausted"}} | \ No newline at end of file diff --git a/docs/models/components/generationcontentresponse.mdx b/docs/models/components/generationcontentresponse.mdx index f28f40788..5c1d31043 100644 --- a/docs/models/components/generationcontentresponse.mdx +++ b/docs/models/components/generationcontentresponse.mdx @@ -9,4 +9,4 @@ Stored prompt and completion content for a generation | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.GenerationContentData](../../models/components/generationcontentdata.mdx) | ✅ | Stored prompt and completion content, plus the failure error when one was stored | \{
"error": null,
"input": \{
"messages": [
\{
"content": "What is the meaning of life?",
"role": "user"
}
]
},
"output": \{
"completion": "The meaning of life is a philosophical question...",
"reasoning": null
}
} | \ No newline at end of file +| `Data` | [components.GenerationContentData](../../models/components/generationcontentdata.mdx) | :heavy_check_mark: | Stored prompt and completion content, plus the failure error when one was stored | \{
"error": null,
"input": \{
"messages": [
\{
"content": "What is the meaning of life?",
"role": "user"
}
]
},
"output": \{
"completion": "The meaning of life is a philosophical question...",
"reasoning": null
}
} | \ No newline at end of file diff --git a/docs/models/components/generationresponse.mdx b/docs/models/components/generationresponse.mdx index bab324c90..11f8aa4d5 100644 --- a/docs/models/components/generationresponse.mdx +++ b/docs/models/components/generationresponse.mdx @@ -9,4 +9,4 @@ Generation response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.GenerationResponseData](../../models/components/generationresponsedata.mdx) | ✅ | Generation data | \ No newline at end of file +| `Data` | [components.GenerationResponseData](../../models/components/generationresponsedata.mdx) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/docs/models/components/generationresponsedata.mdx b/docs/models/components/generationresponsedata.mdx index 7fe4b4ebd..d1c9630b0 100644 --- a/docs/models/components/generationresponsedata.mdx +++ b/docs/models/components/generationresponsedata.mdx @@ -9,48 +9,48 @@ Generation data | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIType` | [*components.APIType](../../models/components/apitype.mdx) | ✅ | Type of API used for the generation | | -| `AppID` | `*int64` | ✅ | ID of the app that made the request | 12345 | -| `CacheDiscount` | `*float64` | ✅ | Discount applied due to caching | 0.0002 | -| `Cancelled` | `*bool` | ✅ | Whether the generation was cancelled | false | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `DataRegion` | [components.GenerationResponseDataRegion](../../models/components/generationresponsedataregion.mdx) | ✅ | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | -| `ExternalUser` | `*string` | ✅ | External user identifier | user-123 | -| `FinishReason` | `*string` | ✅ | Reason the generation finished | stop | -| `GenerationTime` | `*float64` | ✅ | Time taken for generation in milliseconds | 1200 | -| `HTTPReferer` | `*string` | ✅ | Referer header from the request | | -| `ID` | `string` | ✅ | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `IsBYOK` | `bool` | ✅ | Whether this used bring-your-own-key | false | -| `Latency` | `*float64` | ✅ | Total latency in milliseconds | 1250 | -| `Model` | `string` | ✅ | Model used for the generation | sao10k/l3-stheno-8b | -| `ModerationLatency` | `*float64` | ✅ | Moderation latency in milliseconds | 50 | -| `NativeFinishReason` | `*string` | ✅ | Native finish reason as reported by provider | stop | -| `NativeTokensCached` | `*int64` | ✅ | Native cached tokens as reported by provider | 3 | -| `NativeTokensCompletion` | `*int64` | ✅ | Native completion tokens as reported by provider | 25 | -| `NativeTokensCompletionImages` | `*int64` | ✅ | Native completion image tokens as reported by provider | 0 | -| `NativeTokensPrompt` | `*int64` | ✅ | Native prompt tokens as reported by provider | 10 | -| `NativeTokensReasoning` | `*int64` | ✅ | Native reasoning tokens as reported by provider | 5 | -| `NumFetches` | `*int64` | ✅ | Number of web fetches performed | 0 | -| `NumInputAudioPrompt` | `*int64` | ✅ | Number of audio inputs in the prompt | 0 | -| `NumMediaCompletion` | `*int64` | ✅ | Number of media items in the completion | 0 | -| `NumMediaPrompt` | `*int64` | ✅ | Number of media items in the prompt | 1 | -| `NumSearchResults` | `*int64` | ✅ | Number of search results included | 5 | -| `Origin` | `string` | ✅ | Origin URL of the request | https://openrouter.ai/ | -| `PresetID` | `*string` | ✅ | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | -| `ProviderName` | `*string` | ✅ | Name of the provider that served the request | Infermatic | -| `ProviderResponses` | [][components.ProviderResponse](../../models/components/providerresponse.mdx) | ✅ | List of provider responses for this generation, including fallback attempts | | -| `RequestID` | optionalnullable.OptionalNullable[`string`] | ➖ | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | -| `ResponseCacheSourceID` | optionalnullable.OptionalNullable[`string`] | ➖ | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | -| `Router` | `*string` | ✅ | Router used for the request (e.g., openrouter/auto) | openrouter/auto | -| `ServiceTier` | `*string` | ✅ | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | -| `SessionID` | optionalnullable.OptionalNullable[`string`] | ➖ | Session identifier grouping multiple generations in the same session | | -| `Streamed` | `*bool` | ✅ | Whether the response was streamed | true | -| `TokensCompletion` | `*int64` | ✅ | Number of tokens in the completion | 25 | -| `TokensPrompt` | `*int64` | ✅ | Number of tokens in the prompt | 10 | -| `TotalCost` | `float64` | ✅ | Total cost of the generation in USD | 0.0015 | -| `UpstreamID` | `*string` | ✅ | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `UpstreamInferenceCost` | `*float64` | ✅ | Cost charged by the upstream provider | 0.0012 | -| `Usage` | `float64` | ✅ | Usage amount in USD | 0.0015 | -| `UserAgent` | `*string` | ✅ | User-Agent header from the request | | -| `WebSearchEngine` | `*string` | ✅ | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | -| `WorkspaceID` | `*string` | ✅ | ID of the workspace this generation is attributed to. Null for accounts without workspaces. Generations created before workspace resolution existed are attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIType` | [*components.APIType](../../models/components/apitype.mdx) | :heavy_check_mark: | Type of API used for the generation | | +| `AppID` | `*int64` | :heavy_check_mark: | ID of the app that made the request | 12345 | +| `CacheDiscount` | `*float64` | :heavy_check_mark: | Discount applied due to caching | 0.0002 | +| `Cancelled` | `*bool` | :heavy_check_mark: | Whether the generation was cancelled | false | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | +| `DataRegion` | [components.GenerationResponseDataRegion](../../models/components/generationresponsedataregion.mdx) | :heavy_check_mark: | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | +| `ExternalUser` | `*string` | :heavy_check_mark: | External user identifier | user-123 | +| `FinishReason` | `*string` | :heavy_check_mark: | Reason the generation finished | stop | +| `GenerationTime` | `*float64` | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | +| `HTTPReferer` | `*string` | :heavy_check_mark: | Referer header from the request | | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | +| `IsBYOK` | `bool` | :heavy_check_mark: | Whether this used bring-your-own-key | false | +| `Latency` | `*float64` | :heavy_check_mark: | Total latency in milliseconds | 1250 | +| `Model` | `string` | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | +| `ModerationLatency` | `*float64` | :heavy_check_mark: | Moderation latency in milliseconds | 50 | +| `NativeFinishReason` | `*string` | :heavy_check_mark: | Native finish reason as reported by provider | stop | +| `NativeTokensCached` | `*int64` | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | +| `NativeTokensCompletion` | `*int64` | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | +| `NativeTokensCompletionImages` | `*int64` | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | +| `NativeTokensPrompt` | `*int64` | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | +| `NativeTokensReasoning` | `*int64` | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | +| `NumFetches` | `*int64` | :heavy_check_mark: | Number of web fetches performed | 0 | +| `NumInputAudioPrompt` | `*int64` | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | +| `NumMediaCompletion` | `*int64` | :heavy_check_mark: | Number of media items in the completion | 0 | +| `NumMediaPrompt` | `*int64` | :heavy_check_mark: | Number of media items in the prompt | 1 | +| `NumSearchResults` | `*int64` | :heavy_check_mark: | Number of search results included | 5 | +| `Origin` | `string` | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | +| `PresetID` | `*string` | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | +| `ProviderName` | `*string` | :heavy_check_mark: | Name of the provider that served the request | Infermatic | +| `ProviderResponses` | [][components.ProviderResponse](../../models/components/providerresponse.mdx) | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | +| `RequestID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | +| `ResponseCacheSourceID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | +| `Router` | `*string` | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | +| `ServiceTier` | `*string` | :heavy_check_mark: | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | +| `SessionID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Session identifier grouping multiple generations in the same session | | +| `Streamed` | `*bool` | :heavy_check_mark: | Whether the response was streamed | true | +| `TokensCompletion` | `*int64` | :heavy_check_mark: | Number of tokens in the completion | 25 | +| `TokensPrompt` | `*int64` | :heavy_check_mark: | Number of tokens in the prompt | 10 | +| `TotalCost` | `float64` | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | +| `UpstreamID` | `*string` | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | +| `UpstreamInferenceCost` | `*float64` | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | +| `Usage` | `float64` | :heavy_check_mark: | Usage amount in USD | 0.0015 | +| `UserAgent` | `*string` | :heavy_check_mark: | User-Agent header from the request | | +| `WebSearchEngine` | `*string` | :heavy_check_mark: | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | +| `WorkspaceID` | `*string` | :heavy_check_mark: | ID of the workspace this generation is attributed to. Null for accounts without workspaces. Generations created before workspace resolution existed are attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/getbyokkeyresponse.mdx b/docs/models/components/getbyokkeyresponse.mdx index ecf16b051..dab47c1eb 100644 --- a/docs/models/components/getbyokkeyresponse.mdx +++ b/docs/models/components/getbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "GetBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/getguardrailresponse.mdx b/docs/models/components/getguardrailresponse.mdx index 02e6e1c22..5ddc7239c 100644 --- a/docs/models/components/getguardrailresponse.mdx +++ b/docs/models/components/getguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "GetGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/components/getobservabilitydestinationresponse.mdx b/docs/models/components/getobservabilitydestinationresponse.mdx index 1d909318b..ca8695ca4 100644 --- a/docs/models/components/getobservabilitydestinationresponse.mdx +++ b/docs/models/components/getobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "GetObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/getpresetresponse.mdx b/docs/models/components/getpresetresponse.mdx index 2518e05fd..25f1369c5 100644 --- a/docs/models/components/getpresetresponse.mdx +++ b/docs/models/components/getpresetresponse.mdx @@ -9,4 +9,4 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion.mdx) | ✅ | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file +| `Data` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion.mdx) | :heavy_check_mark: | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file diff --git a/docs/models/components/getpresetversionresponse.mdx b/docs/models/components/getpresetversionresponse.mdx index 6fe096b82..522921fc5 100644 --- a/docs/models/components/getpresetversionresponse.mdx +++ b/docs/models/components/getpresetversionresponse.mdx @@ -9,4 +9,4 @@ A single version of a preset. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | ✅ | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file +| `Data` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | :heavy_check_mark: | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file diff --git a/docs/models/components/getscimgroupmappingresponse.mdx b/docs/models/components/getscimgroupmappingresponse.mdx index 85c7bf59f..87fd9daba 100644 --- a/docs/models/components/getscimgroupmappingresponse.mdx +++ b/docs/models/components/getscimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "GetScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/getscimsyncjobresponse.mdx b/docs/models/components/getscimsyncjobresponse.mdx index 4efc64b64..08b956297 100644 --- a/docs/models/components/getscimsyncjobresponse.mdx +++ b/docs/models/components/getscimsyncjobresponse.mdx @@ -6,4 +6,4 @@ title: "GetScimSyncJobResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Data` | [components.ScimSyncJob](../../models/components/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.ScimSyncJob](../../models/components/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/gettoolresponse.mdx b/docs/models/components/gettoolresponse.mdx index 6ed055558..2d4e098d7 100644 --- a/docs/models/components/gettoolresponse.mdx +++ b/docs/models/components/gettoolresponse.mdx @@ -6,4 +6,4 @@ title: "GetToolResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Data` | [components.ServerToolDetails](../../models/components/servertooldetails.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.ServerToolDetails](../../models/components/servertooldetails.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/getworkspacebudgetresponse.mdx b/docs/models/components/getworkspacebudgetresponse.mdx index 732fd994c..ef31c525d 100644 --- a/docs/models/components/getworkspacebudgetresponse.mdx +++ b/docs/models/components/getworkspacebudgetresponse.mdx @@ -6,5 +6,5 @@ title: "GetWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file +| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file diff --git a/docs/models/components/getworkspaceresponse.mdx b/docs/models/components/getworkspaceresponse.mdx index a41105515..cb31c7200 100644 --- a/docs/models/components/getworkspaceresponse.mdx +++ b/docs/models/components/getworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "GetWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `Data` | [components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/components/goneresponseerrordata.mdx b/docs/models/components/goneresponseerrordata.mdx index eda84e5fd..3039016fc 100644 --- a/docs/models/components/goneresponseerrordata.mdx +++ b/docs/models/components/goneresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for GoneResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/guardrail.mdx b/docs/models/components/guardrail.mdx index ffd9979d3..3d75395da 100644 --- a/docs/models/components/guardrail.mdx +++ b/docs/models/components/guardrail.mdx @@ -6,28 +6,28 @@ title: "Guardrail" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. | [
"europe"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntry](../../models/components/contentfilterbuiltinentry.mdx)] | ➖ | Builtin content filters applied to requests. Includes PII detectors and the regex-based prompt injection detector. | [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
] | -| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | ➖ | Custom regex content filters applied to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | Description of the guardrail | Guardrail for production environment | -| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | -| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | -| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `ID` | `string` | ✅ | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | -| `IncludeBYOKInBudgets` | `bool` | ✅ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | -| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | ➖ | Spending limit in USD | 100 | -| `Name` | `string` | ✅ | Name of the guardrail | Production Guardrail | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `UpdatedAt` | optionalnullable.OptionalNullable[`string`] | ➖ | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `*string` | ✅ | The workspace this guardrail belongs to, or `null` for an unscoped legacy guardrail predating workspaces. Workspace membership organizes the guardrail; it does not apply the guardrail to the workspace's traffic. A `null` value does not mean the default workspace, and does not apply the guardrail across every workspace. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. | [
"europe"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntry](../../models/components/contentfilterbuiltinentry.mdx)] | :heavy_minus_sign: | Builtin content filters applied to requests. Includes PII detectors and the regex-based prompt injection detector. | [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
] | +| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters applied to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | +| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | +| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | +| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | +| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | +| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | +| `IncludeBYOKInBudgets` | `bool` | :heavy_check_mark: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | +| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Spending limit in USD | 100 | +| `Name` | `string` | :heavy_check_mark: | Name of the guardrail | Production Guardrail | +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `UpdatedAt` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `*string` | :heavy_check_mark: | The workspace this guardrail belongs to, or `null` for an unscoped legacy guardrail predating workspaces. Workspace membership organizes the guardrail; it does not apply the guardrail to the workspace's traffic. A `null` value does not mean the default workspace, and does not apply the guardrail across every workspace. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/components/image.mdx b/docs/models/components/image.mdx index cf4483767..76a7f7c79 100644 --- a/docs/models/components/image.mdx +++ b/docs/models/components/image.mdx @@ -6,5 +6,5 @@ title: "Image" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ImageURL` | [components.BatchObjectImageURL](../../models/components/batchobjectimageurl.mdx) | ✅ | N/A | -| `Type` | [components.ChoiceTypeImageURL](../../models/components/choicetypeimageurl.mdx) | ✅ | N/A | \ No newline at end of file +| `ImageURL` | [components.BatchObjectImageURL](../../models/components/batchobjectimageurl.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.ChoiceTypeImageURL](../../models/components/choicetypeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imageendpoint.mdx b/docs/models/components/imageendpoint.mdx index 11f6da29f..c0edb162a 100644 --- a/docs/models/components/imageendpoint.mdx +++ b/docs/models/components/imageendpoint.mdx @@ -9,10 +9,10 @@ An endpoint that serves a given image model. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedPassthroughParameters` | []`string` | ✅ | Provider-specific options accepted under provider.options[provider_slug]. | [] | -| `Pricing` | [][components.ImagePricingEntry](../../models/components/imagepricingentry.mdx) | ✅ | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | -| `ProviderName` | `string` | ✅ | Provider display name | Bytedance | -| `ProviderSlug` | `string` | ✅ | Provider slug | bytedance | -| `ProviderTag` | `*string` | ✅ | Provider tag for request-side selection | bytedance | -| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | ✅ | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | -| `SupportsStreaming` | `bool` | ✅ | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file +| `AllowedPassthroughParameters` | []`string` | :heavy_check_mark: | Provider-specific options accepted under provider.options[provider_slug]. | [] | +| `Pricing` | [][components.ImagePricingEntry](../../models/components/imagepricingentry.mdx) | :heavy_check_mark: | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | +| `ProviderName` | `string` | :heavy_check_mark: | Provider display name | Bytedance | +| `ProviderSlug` | `string` | :heavy_check_mark: | Provider slug | bytedance | +| `ProviderTag` | `*string` | :heavy_check_mark: | Provider tag for request-side selection | bytedance | +| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | :heavy_check_mark: | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | +| `SupportsStreaming` | `bool` | :heavy_check_mark: | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file diff --git a/docs/models/components/imagegencallcompletedevent.mdx b/docs/models/components/imagegencallcompletedevent.mdx index b481b2b82..c889cb29b 100644 --- a/docs/models/components/imagegencallcompletedevent.mdx +++ b/docs/models/components/imagegencallcompletedevent.mdx @@ -9,7 +9,7 @@ Image generation call completed | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ImageGenCallCompletedEventType](../../models/components/imagegencallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ImageGenCallCompletedEventType](../../models/components/imagegencallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallgeneratingevent.mdx b/docs/models/components/imagegencallgeneratingevent.mdx index 6742e0501..5d6441a8f 100644 --- a/docs/models/components/imagegencallgeneratingevent.mdx +++ b/docs/models/components/imagegencallgeneratingevent.mdx @@ -9,7 +9,7 @@ Image generation call is generating | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ImageGenCallGeneratingEventType](../../models/components/imagegencallgeneratingeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ImageGenCallGeneratingEventType](../../models/components/imagegencallgeneratingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallinprogressevent.mdx b/docs/models/components/imagegencallinprogressevent.mdx index 0887462c2..9de51b343 100644 --- a/docs/models/components/imagegencallinprogressevent.mdx +++ b/docs/models/components/imagegencallinprogressevent.mdx @@ -9,7 +9,7 @@ Image generation call in progress | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ImageGenCallInProgressEventType](../../models/components/imagegencallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ImageGenCallInProgressEventType](../../models/components/imagegencallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallpartialimageevent.mdx b/docs/models/components/imagegencallpartialimageevent.mdx index 707a3d24e..bb25583fe 100644 --- a/docs/models/components/imagegencallpartialimageevent.mdx +++ b/docs/models/components/imagegencallpartialimageevent.mdx @@ -9,9 +9,9 @@ Image generation call with partial image | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `PartialImageB64` | `string` | ✅ | N/A | -| `PartialImageIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ImageGenCallPartialImageEventType](../../models/components/imagegencallpartialimageeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `PartialImageB64` | `string` | :heavy_check_mark: | N/A | +| `PartialImageIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ImageGenCallPartialImageEventType](../../models/components/imagegencallpartialimageeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencompletedevent.mdx b/docs/models/components/imagegencompletedevent.mdx index 6d9736d5b..a7420ac7c 100644 --- a/docs/models/components/imagegencompletedevent.mdx +++ b/docs/models/components/imagegencompletedevent.mdx @@ -9,8 +9,8 @@ Emitted when generation completes and the final image is available | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `B64JSON` | `string` | ✅ | Base64-encoded final image data | | -| `Created` | `int64` | ✅ | Unix timestamp (seconds) when the image was generated | | -| `MediaType` | `*string` | ➖ | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | -| `Type` | [components.ImageGenCompletedEventType](../../models/components/imagegencompletedeventtype.mdx) | ✅ | The event type | | -| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage.mdx) | ➖ | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file +| `B64JSON` | `string` | :heavy_check_mark: | Base64-encoded final image data | | +| `Created` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | | +| `MediaType` | `*string` | :heavy_minus_sign: | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | +| `Type` | [components.ImageGenCompletedEventType](../../models/components/imagegencompletedeventtype.mdx) | :heavy_check_mark: | The event type | | +| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage.mdx) | :heavy_minus_sign: | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file diff --git a/docs/models/components/imagegeneration.mdx b/docs/models/components/imagegeneration.mdx index 6b6ddf16a..4e09cd3ed 100644 --- a/docs/models/components/imagegeneration.mdx +++ b/docs/models/components/imagegeneration.mdx @@ -6,6 +6,6 @@ title: "ImageGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/imagegenerationproviderpreferences.mdx b/docs/models/components/imagegenerationproviderpreferences.mdx index ac592c75a..5fe499abf 100644 --- a/docs/models/components/imagegenerationproviderpreferences.mdx +++ b/docs/models/components/imagegenerationproviderpreferences.mdx @@ -9,9 +9,9 @@ Provider routing preferences and provider-specific passthrough configuration. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `Ignore` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesIgnore](../../models/components/imagegenerationproviderpreferencesignore.mdx)] | ➖ | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | -| `Only` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOnly](../../models/components/imagegenerationproviderpreferencesonly.mdx)] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | -| `Options` | [*components.ImageGenerationProviderPreferencesOptions](../../models/components/imagegenerationproviderpreferencesoptions.mdx) | ➖ | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | -| `Order` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOrder](../../models/components/imagegenerationproviderpreferencesorder.mdx)] | ➖ | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | -| `Sort` | optionalnullable.OptionalNullable[[components.ImageGenerationProviderPreferencesSort](../../models/components/imagegenerationproviderpreferencessort.mdx)] | ➖ | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | \ No newline at end of file +| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `Ignore` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesIgnore](../../models/components/imagegenerationproviderpreferencesignore.mdx)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | +| `Only` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOnly](../../models/components/imagegenerationproviderpreferencesonly.mdx)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | +| `Options` | [*components.ImageGenerationProviderPreferencesOptions](../../models/components/imagegenerationproviderpreferencesoptions.mdx) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | +| `Order` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOrder](../../models/components/imagegenerationproviderpreferencesorder.mdx)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | +| `Sort` | optionalnullable.OptionalNullable[[components.ImageGenerationProviderPreferencesSort](../../models/components/imagegenerationproviderpreferencessort.mdx)] | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | \ No newline at end of file diff --git a/docs/models/components/imagegenerationproviderpreferencesoptions.mdx b/docs/models/components/imagegenerationproviderpreferencesoptions.mdx index 2ac6ec07b..47ddabc35 100644 --- a/docs/models/components/imagegenerationproviderpreferencesoptions.mdx +++ b/docs/models/components/imagegenerationproviderpreferencesoptions.mdx @@ -9,149 +9,149 @@ Provider-specific options keyed by provider slug. Only options for the matched p | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Oneai` | map[string]`any` | ➖ | N/A | -| `Ai21` | map[string]`any` | ➖ | N/A | -| `AionLabs` | map[string]`any` | ➖ | N/A | -| `Akashml` | map[string]`any` | ➖ | N/A | -| `Alibaba` | map[string]`any` | ➖ | N/A | -| `AmazonBedrock` | map[string]`any` | ➖ | N/A | -| `AmazonBedrockClaudeOnAws` | map[string]`any` | ➖ | N/A | -| `AmazonNova` | map[string]`any` | ➖ | N/A | -| `Ambient` | map[string]`any` | ➖ | N/A | -| `Anthropic` | map[string]`any` | ➖ | N/A | -| `Anthropic2` | map[string]`any` | ➖ | N/A | -| `Anyscale` | map[string]`any` | ➖ | N/A | -| `ArceeAi` | map[string]`any` | ➖ | N/A | -| `Assemblyai` | map[string]`any` | ➖ | N/A | -| `AtlasCloud` | map[string]`any` | ➖ | N/A | -| `Atoma` | map[string]`any` | ➖ | N/A | -| `Avian` | map[string]`any` | ➖ | N/A | -| `Azure` | map[string]`any` | ➖ | N/A | -| `Baidu` | map[string]`any` | ➖ | N/A | -| `Baseten` | map[string]`any` | ➖ | N/A | -| `BlackForestLabs` | map[string]`any` | ➖ | N/A | -| `Byteplus` | map[string]`any` | ➖ | N/A | -| `Centml` | map[string]`any` | ➖ | N/A | -| `Cerebras` | map[string]`any` | ➖ | N/A | -| `Chutes` | map[string]`any` | ➖ | N/A | -| `Cirrascale` | map[string]`any` | ➖ | N/A | -| `Clarifai` | map[string]`any` | ➖ | N/A | -| `ClaudeOnAws` | map[string]`any` | ➖ | N/A | -| `Cloudflare` | map[string]`any` | ➖ | N/A | -| `Cohere` | map[string]`any` | ➖ | N/A | -| `Coreweave` | map[string]`any` | ➖ | N/A | -| `Cosine` | map[string]`any` | ➖ | N/A | -| `Crofai` | map[string]`any` | ➖ | N/A | -| `Crucible` | map[string]`any` | ➖ | N/A | -| `Crusoe` | map[string]`any` | ➖ | N/A | -| `Darkbloom` | map[string]`any` | ➖ | N/A | -| `Databricks` | map[string]`any` | ➖ | N/A | -| `Decart` | map[string]`any` | ➖ | N/A | -| `Deepgram` | map[string]`any` | ➖ | N/A | -| `Deepinfra` | map[string]`any` | ➖ | N/A | -| `Deepseek` | map[string]`any` | ➖ | N/A | -| `Dekallm` | map[string]`any` | ➖ | N/A | -| `Digitalocean` | map[string]`any` | ➖ | N/A | -| `Elevenlabs` | map[string]`any` | ➖ | N/A | -| `Enfer` | map[string]`any` | ➖ | N/A | -| `FakeProvider` | map[string]`any` | ➖ | N/A | -| `Featherless` | map[string]`any` | ➖ | N/A | -| `Fireworks` | map[string]`any` | ➖ | N/A | -| `FishAudio` | map[string]`any` | ➖ | N/A | -| `Friendli` | map[string]`any` | ➖ | N/A | -| `Gmicloud` | map[string]`any` | ➖ | N/A | -| `GoogleAiStudio` | map[string]`any` | ➖ | N/A | -| `GoogleVertex` | map[string]`any` | ➖ | N/A | -| `Gopomelo` | map[string]`any` | ➖ | N/A | -| `Groq` | map[string]`any` | ➖ | N/A | -| `Heygen` | map[string]`any` | ➖ | N/A | -| `Huggingface` | map[string]`any` | ➖ | N/A | -| `Hyperbolic` | map[string]`any` | ➖ | N/A | -| `HyperbolicQuantized` | map[string]`any` | ➖ | N/A | -| `Inception` | map[string]`any` | ➖ | N/A | -| `Inceptron` | map[string]`any` | ➖ | N/A | -| `InferactVllm` | map[string]`any` | ➖ | N/A | -| `InferenceNet` | map[string]`any` | ➖ | N/A | -| `Infermatic` | map[string]`any` | ➖ | N/A | -| `Inflection` | map[string]`any` | ➖ | N/A | -| `Inocloud` | map[string]`any` | ➖ | N/A | -| `IoNet` | map[string]`any` | ➖ | N/A | -| `Ionstream` | map[string]`any` | ➖ | N/A | -| `Klusterai` | map[string]`any` | ➖ | N/A | -| `Krea` | map[string]`any` | ➖ | N/A | -| `Lambda` | map[string]`any` | ➖ | N/A | -| `Lepton` | map[string]`any` | ➖ | N/A | -| `Liquid` | map[string]`any` | ➖ | N/A | -| `Lynn` | map[string]`any` | ➖ | N/A | -| `LynnPrivate` | map[string]`any` | ➖ | N/A | -| `Makora` | map[string]`any` | ➖ | N/A | -| `Mancer` | map[string]`any` | ➖ | N/A | -| `MancerOld` | map[string]`any` | ➖ | N/A | -| `Mara` | map[string]`any` | ➖ | N/A | -| `Meta` | map[string]`any` | ➖ | N/A | -| `Minimax` | map[string]`any` | ➖ | N/A | -| `Mistral` | map[string]`any` | ➖ | N/A | -| `Modal` | map[string]`any` | ➖ | N/A | -| `Modelrun` | map[string]`any` | ➖ | N/A | -| `Modular` | map[string]`any` | ➖ | N/A | -| `Moonshotai` | map[string]`any` | ➖ | N/A | -| `Morph` | map[string]`any` | ➖ | N/A | -| `Ncompass` | map[string]`any` | ➖ | N/A | -| `NearAi` | map[string]`any` | ➖ | N/A | -| `Nebius` | map[string]`any` | ➖ | N/A | -| `NexAgi` | map[string]`any` | ➖ | N/A | -| `Nextbit` | map[string]`any` | ➖ | N/A | -| `Nineteen` | map[string]`any` | ➖ | N/A | -| `Novita` | map[string]`any` | ➖ | N/A | -| `Nvidia` | map[string]`any` | ➖ | N/A | -| `Octoai` | map[string]`any` | ➖ | N/A | -| `Ollama` | map[string]`any` | ➖ | N/A | -| `OpenInference` | map[string]`any` | ➖ | N/A | -| `Openai` | map[string]`any` | ➖ | N/A | -| `Parasail` | map[string]`any` | ➖ | N/A | -| `Perceptron` | map[string]`any` | ➖ | N/A | -| `Perplexity` | map[string]`any` | ➖ | N/A | -| `Phala` | map[string]`any` | ➖ | N/A | -| `Poolside` | map[string]`any` | ➖ | N/A | -| `Primeintellect` | map[string]`any` | ➖ | N/A | -| `Quiver` | map[string]`any` | ➖ | N/A | -| `Recraft` | map[string]`any` | ➖ | N/A | -| `Recursal` | map[string]`any` | ➖ | N/A | -| `Reflection` | map[string]`any` | ➖ | N/A | -| `Reka` | map[string]`any` | ➖ | N/A | -| `Relace` | map[string]`any` | ➖ | N/A | -| `Replicate` | map[string]`any` | ➖ | N/A | -| `Respan` | map[string]`any` | ➖ | N/A | -| `Runway` | map[string]`any` | ➖ | N/A | -| `SailResearch` | map[string]`any` | ➖ | N/A | -| `Sakana` | map[string]`any` | ➖ | N/A | -| `SakanaAi` | map[string]`any` | ➖ | N/A | -| `Sambanova` | map[string]`any` | ➖ | N/A | -| `SambanovaCloaked` | map[string]`any` | ➖ | N/A | -| `Scaledown` | map[string]`any` | ➖ | N/A | -| `Seed` | map[string]`any` | ➖ | N/A | -| `SfCompute` | map[string]`any` | ➖ | N/A | -| `Siliconflow` | map[string]`any` | ➖ | N/A | -| `Sourceful` | map[string]`any` | ➖ | N/A | -| `Stealth` | map[string]`any` | ➖ | N/A | -| `Stepfun` | map[string]`any` | ➖ | N/A | -| `Streamlake` | map[string]`any` | ➖ | N/A | -| `Switchpoint` | map[string]`any` | ➖ | N/A | -| `Targon` | map[string]`any` | ➖ | N/A | -| `Tencent` | map[string]`any` | ➖ | N/A | -| `Tenstorrent` | map[string]`any` | ➖ | N/A | -| `Thinkingmachines` | map[string]`any` | ➖ | N/A | -| `Together` | map[string]`any` | ➖ | N/A | -| `TogetherLite` | map[string]`any` | ➖ | N/A | -| `Typesafe` | map[string]`any` | ➖ | N/A | -| `Ubicloud` | map[string]`any` | ➖ | N/A | -| `Unbiased` | map[string]`any` | ➖ | N/A | -| `Upstage` | map[string]`any` | ➖ | N/A | -| `Venice` | map[string]`any` | ➖ | N/A | -| `Voyageai` | map[string]`any` | ➖ | N/A | -| `Wafer` | map[string]`any` | ➖ | N/A | -| `Wandb` | map[string]`any` | ➖ | N/A | -| `WandbLegacy` | map[string]`any` | ➖ | N/A | -| `Xai` | map[string]`any` | ➖ | N/A | -| `Xiaomi` | map[string]`any` | ➖ | N/A | -| `ZAi` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Oneai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ai21` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AionLabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Akashml` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Alibaba` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonBedrock` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonBedrockClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonNova` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ambient` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anthropic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anthropic2` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anyscale` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ArceeAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Assemblyai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AtlasCloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Atoma` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Avian` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Azure` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Baidu` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Baseten` | map[string]`any` | :heavy_minus_sign: | N/A | +| `BlackForestLabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Byteplus` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Centml` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cerebras` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Chutes` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cirrascale` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Clarifai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cloudflare` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cohere` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Coreweave` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cosine` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crofai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crucible` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crusoe` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Darkbloom` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Databricks` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Decart` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepgram` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepinfra` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepseek` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Dekallm` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Digitalocean` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Elevenlabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Enfer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `FakeProvider` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Featherless` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Fireworks` | map[string]`any` | :heavy_minus_sign: | N/A | +| `FishAudio` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Friendli` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Gmicloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `GoogleAiStudio` | map[string]`any` | :heavy_minus_sign: | N/A | +| `GoogleVertex` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Gopomelo` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Groq` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Heygen` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Huggingface` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Hyperbolic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `HyperbolicQuantized` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inception` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inceptron` | map[string]`any` | :heavy_minus_sign: | N/A | +| `InferactVllm` | map[string]`any` | :heavy_minus_sign: | N/A | +| `InferenceNet` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Infermatic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inflection` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inocloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `IoNet` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ionstream` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Klusterai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Krea` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lambda` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lepton` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Liquid` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lynn` | map[string]`any` | :heavy_minus_sign: | N/A | +| `LynnPrivate` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Makora` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mancer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `MancerOld` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mara` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Meta` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Minimax` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mistral` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modal` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modelrun` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modular` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Moonshotai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Morph` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ncompass` | map[string]`any` | :heavy_minus_sign: | N/A | +| `NearAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nebius` | map[string]`any` | :heavy_minus_sign: | N/A | +| `NexAgi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nextbit` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nineteen` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Novita` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nvidia` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Octoai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ollama` | map[string]`any` | :heavy_minus_sign: | N/A | +| `OpenInference` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Openai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Parasail` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Perceptron` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Perplexity` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Phala` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Poolside` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Primeintellect` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Quiver` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Recraft` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Recursal` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Reflection` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Reka` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Relace` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Replicate` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Respan` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Runway` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SailResearch` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sakana` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SakanaAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sambanova` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SambanovaCloaked` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Scaledown` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Seed` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SfCompute` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Siliconflow` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sourceful` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Stealth` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Stepfun` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Streamlake` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Switchpoint` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Targon` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Tencent` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Tenstorrent` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Thinkingmachines` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Together` | map[string]`any` | :heavy_minus_sign: | N/A | +| `TogetherLite` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Typesafe` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ubicloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Unbiased` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Upstage` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Venice` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Voyageai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Wafer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Wandb` | map[string]`any` | :heavy_minus_sign: | N/A | +| `WandbLegacy` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Xai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Xiaomi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ZAi` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegenerationrequest.mdx b/docs/models/components/imagegenerationrequest.mdx index 6be4687ae..591544620 100644 --- a/docs/models/components/imagegenerationrequest.mdx +++ b/docs/models/components/imagegenerationrequest.mdx @@ -9,20 +9,20 @@ Image generation request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AspectRatio` | [*components.ImageGenerationRequestAspectRatio](../../models/components/imagegenerationrequestaspectratio.mdx) | ➖ | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `Background` | [*components.ImageGenerationRequestBackground](../../models/components/imagegenerationrequestbackground.mdx) | ➖ | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `InputReferences` | [][components.ContentPartImage](../../models/components/contentpartimage.mdx) | ➖ | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | -| `Model` | `string` | ✅ | The image generation model to use | bytedance-seed/seedream-4.5 | -| `N` | `*int64` | ➖ | Upper bound on the number of images to generate (1-10). Providers may return fewer images, and providers that only support single-image generation reject n > 1. | 1 | -| `OutputCompression` | `*int64` | ➖ | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `OutputFormat` | [*components.ImageGenerationRequestOutputFormat](../../models/components/imagegenerationrequestoutputformat.mdx) | ➖ | Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`. | png | -| `Prompt` | `string` | ✅ | Text description of the desired image | a red panda astronaut floating in space, studio lighting | -| `Provider` | [*components.ImageGenerationProviderPreferences](../../models/components/imagegenerationproviderpreferences.mdx) | ➖ | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `Quality` | [*components.ImageGenerationRequestQuality](../../models/components/imagegenerationrequestquality.mdx) | ➖ | Rendering quality. Providers without a quality knob ignore this. | high | -| `Resolution` | [*components.ImageGenerationRequestResolution](../../models/components/imagegenerationrequestresolution.mdx) | ➖ | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | -| `Seed` | `*int64` | ➖ | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Size` | `*string` | ➖ | Optional. A convenience shorthand for output dimensions — pass a tier ("2K", "4K") or explicit pixels ("2048x2048") and we normalize it to the right dimensions for the chosen provider. A tier size is equivalent to setting `resolution` and combines with `aspect_ratio`. An explicit pixel size is authoritative: a mismatched `resolution` or `aspect_ratio` alongside it is rejected with a 400. | 2K | -| `Stream` | `*bool` | ➖ | If true, partial images are streamed as SSE events as they become available. Only supported by providers with native streaming (currently OpenAI). Non-streaming providers ignore this flag and return a buffered response. | | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | ➖ | A stable identifier for your end-users. Used to help detect and prevent abuse. Never sent to providers verbatim: for providers whose data policy requires user IDs, it is folded into a hashed, per-account upstream user identifier. | end-user-abc123 | \ No newline at end of file +| `AspectRatio` | [*components.ImageGenerationRequestAspectRatio](../../models/components/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `Background` | [*components.ImageGenerationRequestBackground](../../models/components/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `InputReferences` | [][components.ContentPartImage](../../models/components/contentpartimage.mdx) | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `Model` | `string` | :heavy_check_mark: | The image generation model to use | bytedance-seed/seedream-4.5 | +| `N` | `*int64` | :heavy_minus_sign: | Upper bound on the number of images to generate (1-10). Providers may return fewer images, and providers that only support single-image generation reject n > 1. | 1 | +| `OutputCompression` | `*int64` | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | +| `OutputFormat` | [*components.ImageGenerationRequestOutputFormat](../../models/components/imagegenerationrequestoutputformat.mdx) | :heavy_minus_sign: | Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`. | png | +| `Prompt` | `string` | :heavy_check_mark: | Text description of the desired image | a red panda astronaut floating in space, studio lighting | +| `Provider` | [*components.ImageGenerationProviderPreferences](../../models/components/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `Quality` | [*components.ImageGenerationRequestQuality](../../models/components/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | +| `Resolution` | [*components.ImageGenerationRequestResolution](../../models/components/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `Seed` | `*int64` | :heavy_minus_sign: | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Size` | `*string` | :heavy_minus_sign: | Optional. A convenience shorthand for output dimensions — pass a tier ("2K", "4K") or explicit pixels ("2048x2048") and we normalize it to the right dimensions for the chosen provider. A tier size is equivalent to setting `resolution` and combines with `aspect_ratio`. An explicit pixel size is authoritative: a mismatched `resolution` or `aspect_ratio` alongside it is rejected with a 400. | 2K | +| `Stream` | `*bool` | :heavy_minus_sign: | If true, partial images are streamed as SSE events as they become available. Only supported by providers with native streaming (currently OpenAI). Non-streaming providers ignore this flag and return a buffered response. | | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | :heavy_minus_sign: | A stable identifier for your end-users. Used to help detect and prevent abuse. Never sent to providers verbatim: for providers whose data policy requires user IDs, it is folded into a hashed, per-account upstream user identifier. | end-user-abc123 | \ No newline at end of file diff --git a/docs/models/components/imagegenerationresponse.mdx b/docs/models/components/imagegenerationresponse.mdx index 80306ad6f..647efd062 100644 --- a/docs/models/components/imagegenerationresponse.mdx +++ b/docs/models/components/imagegenerationresponse.mdx @@ -9,6 +9,6 @@ Image generation response | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Created` | `int64` | ✅ | Unix timestamp (seconds) when the image was generated | 1748372400 | -| `Data` | [][components.ImageGenerationResponseData](../../models/components/imagegenerationresponsedata.mdx) | ✅ | Generated images | | -| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage.mdx) | ➖ | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file +| `Created` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | 1748372400 | +| `Data` | [][components.ImageGenerationResponseData](../../models/components/imagegenerationresponsedata.mdx) | :heavy_check_mark: | Generated images | | +| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage.mdx) | :heavy_minus_sign: | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file diff --git a/docs/models/components/imagegenerationresponsedata.mdx b/docs/models/components/imagegenerationresponsedata.mdx index fb419aa93..059de7fe7 100644 --- a/docs/models/components/imagegenerationresponsedata.mdx +++ b/docs/models/components/imagegenerationresponsedata.mdx @@ -6,5 +6,5 @@ title: "ImageGenerationResponseData" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `B64JSON` | `string` | ✅ | Base64-encoded image bytes | | -| `MediaType` | `*string` | ➖ | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | \ No newline at end of file +| `B64JSON` | `string` | :heavy_check_mark: | Base64-encoded image bytes | | +| `MediaType` | `*string` | :heavy_minus_sign: | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | \ No newline at end of file diff --git a/docs/models/components/imagegenerationservertool.mdx b/docs/models/components/imagegenerationservertool.mdx index edc1d573e..c24479a3d 100644 --- a/docs/models/components/imagegenerationservertool.mdx +++ b/docs/models/components/imagegenerationservertool.mdx @@ -9,14 +9,14 @@ Image generation tool configuration | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `Background` | [*components.ImageGenerationServerToolBackground](../../models/components/imagegenerationservertoolbackground.mdx) | ➖ | N/A | -| `InputFidelity` | optionalnullable.OptionalNullable[[components.InputFidelity](../../models/components/inputfidelity.mdx)] | ➖ | N/A | -| `InputImageMask` | [*components.InputImageMask](../../models/components/inputimagemask.mdx) | ➖ | N/A | -| `Model` | `*string` | ➖ | N/A | -| `Moderation` | [*components.Moderation](../../models/components/moderation.mdx) | ➖ | N/A | -| `OutputCompression` | `*int64` | ➖ | N/A | -| `OutputFormat` | [*components.ImageGenerationServerToolOutputFormat](../../models/components/imagegenerationservertooloutputformat.mdx) | ➖ | N/A | -| `PartialImages` | `*int64` | ➖ | N/A | -| `Quality` | [*components.ImageGenerationServerToolQuality](../../models/components/imagegenerationservertoolquality.mdx) | ➖ | N/A | -| `Size` | `*string` | ➖ | N/A | -| `Type` | [components.ImageGenerationServerToolType](../../models/components/imagegenerationservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `Background` | [*components.ImageGenerationServerToolBackground](../../models/components/imagegenerationservertoolbackground.mdx) | :heavy_minus_sign: | N/A | +| `InputFidelity` | optionalnullable.OptionalNullable[[components.InputFidelity](../../models/components/inputfidelity.mdx)] | :heavy_minus_sign: | N/A | +| `InputImageMask` | [*components.InputImageMask](../../models/components/inputimagemask.mdx) | :heavy_minus_sign: | N/A | +| `Model` | `*string` | :heavy_minus_sign: | N/A | +| `Moderation` | [*components.Moderation](../../models/components/moderation.mdx) | :heavy_minus_sign: | N/A | +| `OutputCompression` | `*int64` | :heavy_minus_sign: | N/A | +| `OutputFormat` | [*components.ImageGenerationServerToolOutputFormat](../../models/components/imagegenerationservertooloutputformat.mdx) | :heavy_minus_sign: | N/A | +| `PartialImages` | `*int64` | :heavy_minus_sign: | N/A | +| `Quality` | [*components.ImageGenerationServerToolQuality](../../models/components/imagegenerationservertoolquality.mdx) | :heavy_minus_sign: | N/A | +| `Size` | `*string` | :heavy_minus_sign: | N/A | +| `Type` | [components.ImageGenerationServerToolType](../../models/components/imagegenerationservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegenerationservertoolconfig.mdx b/docs/models/components/imagegenerationservertoolconfig.mdx index cea9b5bd3..62883b6dd 100644 --- a/docs/models/components/imagegenerationservertoolconfig.mdx +++ b/docs/models/components/imagegenerationservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:image_generation server tool. Accepts all image | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `Model` | `*string` | ➖ | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | -| `AdditionalProperties` | map[string][components.ImageGenerationServerToolConfigUnion](../../models/components/imagegenerationservertoolconfigunion.mdx) | ➖ | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file +| `Model` | `*string` | :heavy_minus_sign: | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | +| `AdditionalProperties` | map[string][components.ImageGenerationServerToolConfigUnion](../../models/components/imagegenerationservertoolconfigunion.mdx) | :heavy_minus_sign: | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file diff --git a/docs/models/components/imagegenerationservertoolopenrouter.mdx b/docs/models/components/imagegenerationservertoolopenrouter.mdx index 8f8ff0440..d2b382539 100644 --- a/docs/models/components/imagegenerationservertoolopenrouter.mdx +++ b/docs/models/components/imagegenerationservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: generates images from text prompts using an ima | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ImageGenerationServerToolConfig](../../models/components/imagegenerationservertoolconfig.mdx) | ➖ | Configuration for the openrouter:image_generation server tool. Accepts all image_config params (aspect_ratio, quality, size, background, output_format, output_compression, moderation, etc.) plus a model field. | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | -| `Type` | [components.ImageGenerationServerToolOpenRouterType](../../models/components/imagegenerationservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.ImageGenerationServerToolConfig](../../models/components/imagegenerationservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:image_generation server tool. Accepts all image_config params (aspect_ratio, quality, size, background, output_format, output_compression, moderation, etc.) plus a model field. | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | +| `Type` | [components.ImageGenerationServerToolOpenRouterType](../../models/components/imagegenerationservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusage.mdx b/docs/models/components/imagegenerationusage.mdx index e8a39b7a4..0a440a4d1 100644 --- a/docs/models/components/imagegenerationusage.mdx +++ b/docs/models/components/imagegenerationusage.mdx @@ -9,16 +9,16 @@ Token and cost usage for the image generation request, when available | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CompletionTokens` | `int64` | ✅ | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageCompletionTokensDetails](../../models/components/imagegenerationusagecompletiontokensdetails.mdx)] | ➖ | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | ➖ | N/A | | -| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsagePromptTokensDetails](../../models/components/imagegenerationusageprompttokensdetails.mdx)] | ➖ | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageServerToolUse](../../models/components/imagegenerationusageservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | -| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageCompletionTokensDetails](../../models/components/imagegenerationusagecompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsagePromptTokensDetails](../../models/components/imagegenerationusageprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageServerToolUse](../../models/components/imagegenerationusageservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | +| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusagecompletiontokensdetails.mdx b/docs/models/components/imagegenerationusagecompletiontokensdetails.mdx index bdef0ab07..0acb8d17b 100644 --- a/docs/models/components/imagegenerationusagecompletiontokensdetails.mdx +++ b/docs/models/components/imagegenerationusagecompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "ImageGenerationUsageCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusageprompttokensdetails.mdx b/docs/models/components/imagegenerationusageprompttokensdetails.mdx index e99012656..bea48beee 100644 --- a/docs/models/components/imagegenerationusageprompttokensdetails.mdx +++ b/docs/models/components/imagegenerationusageprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusageservertooluse.mdx b/docs/models/components/imagegenerationusageservertooluse.mdx index 436c7cc1d..026d04635 100644 --- a/docs/models/components/imagegenerationusageservertooluse.mdx +++ b/docs/models/components/imagegenerationusageservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/imagegenpartialimageevent.mdx b/docs/models/components/imagegenpartialimageevent.mdx index 0e1bc5fc1..2481d04e2 100644 --- a/docs/models/components/imagegenpartialimageevent.mdx +++ b/docs/models/components/imagegenpartialimageevent.mdx @@ -9,6 +9,6 @@ Emitted when a partial image becomes available during streaming generation | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `B64JSON` | `string` | ✅ | Base64-encoded partial image data | -| `PartialImageIndex` | `int64` | ✅ | 0-based index indicating which partial image this is in the sequence | -| `Type` | [components.ImageGenPartialImageEventType](../../models/components/imagegenpartialimageeventtype.mdx) | ✅ | The event type | \ No newline at end of file +| `B64JSON` | `string` | :heavy_check_mark: | Base64-encoded partial image data | +| `PartialImageIndex` | `int64` | :heavy_check_mark: | 0-based index indicating which partial image this is in the sequence | +| `Type` | [components.ImageGenPartialImageEventType](../../models/components/imagegenpartialimageeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/models/components/imagegenstreamerrorevent.mdx b/docs/models/components/imagegenstreamerrorevent.mdx index 7d6a04b0d..3d9017709 100644 --- a/docs/models/components/imagegenstreamerrorevent.mdx +++ b/docs/models/components/imagegenstreamerrorevent.mdx @@ -9,5 +9,5 @@ Emitted when streaming generation fails after the SSE response starts | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Error` | [components.ImageGenStreamErrorEventError](../../models/components/imagegenstreamerroreventerror.mdx) | ✅ | Provider error details | -| `Type` | [components.ImageGenStreamErrorEventType](../../models/components/imagegenstreamerroreventtype.mdx) | ✅ | The event type | \ No newline at end of file +| `Error` | [components.ImageGenStreamErrorEventError](../../models/components/imagegenstreamerroreventerror.mdx) | :heavy_check_mark: | Provider error details | +| `Type` | [components.ImageGenStreamErrorEventType](../../models/components/imagegenstreamerroreventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/models/components/imagegenstreamerroreventerror.mdx b/docs/models/components/imagegenstreamerroreventerror.mdx index d63e94fb2..795edd62f 100644 --- a/docs/models/components/imagegenstreamerroreventerror.mdx +++ b/docs/models/components/imagegenstreamerroreventerror.mdx @@ -9,7 +9,7 @@ Provider error details | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Code` | optionalnullable.OptionalNullable[`string`] | ➖ | Provider error code, when supplied | -| `Message` | `string` | ✅ | Provider error message | -| `Param` | optionalnullable.OptionalNullable[`string`] | ➖ | Request parameter associated with the error, when supplied | -| `Type` | optionalnullable.OptionalNullable[`string`] | ➖ | Provider error type, when supplied | \ No newline at end of file +| `Code` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Provider error code, when supplied | +| `Message` | `string` | :heavy_check_mark: | Provider error message | +| `Param` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Request parameter associated with the error, when supplied | +| `Type` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Provider error type, when supplied | \ No newline at end of file diff --git a/docs/models/components/imagegentextchunkevent.mdx b/docs/models/components/imagegentextchunkevent.mdx index e646227f4..46d1a6b30 100644 --- a/docs/models/components/imagegentextchunkevent.mdx +++ b/docs/models/components/imagegentextchunkevent.mdx @@ -9,6 +9,6 @@ Emitted when a text chunk becomes available during streaming generation of text- | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Phase` | [components.ImageGenTextChunkEventPhase](../../models/components/imagegentextchunkeventphase.mdx) | ✅ | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | -| `Text` | `string` | ✅ | A text fragment of the image being generated (e.g. partial SVG markup) | -| `Type` | [components.ImageGenTextChunkEventType](../../models/components/imagegentextchunkeventtype.mdx) | ✅ | The event type | \ No newline at end of file +| `Phase` | [components.ImageGenTextChunkEventPhase](../../models/components/imagegentextchunkeventphase.mdx) | :heavy_check_mark: | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | +| `Text` | `string` | :heavy_check_mark: | A text fragment of the image being generated (e.g. partial SVG markup) | +| `Type` | [components.ImageGenTextChunkEventType](../../models/components/imagegentextchunkeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/models/components/imagemodelarchitecture.mdx b/docs/models/components/imagemodelarchitecture.mdx index c7fd8fee7..467a9ccf1 100644 --- a/docs/models/components/imagemodelarchitecture.mdx +++ b/docs/models/components/imagemodelarchitecture.mdx @@ -6,5 +6,5 @@ title: "ImageModelArchitecture" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `InputModalities` | [][components.ImageInputModality](../../models/components/imageinputmodality.mdx) | ✅ | Supported input modalities | -| `OutputModalities` | [][components.ImageOutputModality](../../models/components/imageoutputmodality.mdx) | ✅ | Supported output modalities | \ No newline at end of file +| `InputModalities` | [][components.ImageInputModality](../../models/components/imageinputmodality.mdx) | :heavy_check_mark: | Supported input modalities | +| `OutputModalities` | [][components.ImageOutputModality](../../models/components/imageoutputmodality.mdx) | :heavy_check_mark: | Supported output modalities | \ No newline at end of file diff --git a/docs/models/components/imagemodelendpointsresponse.mdx b/docs/models/components/imagemodelendpointsresponse.mdx index e26c117f7..8423e8460 100644 --- a/docs/models/components/imagemodelendpointsresponse.mdx +++ b/docs/models/components/imagemodelendpointsresponse.mdx @@ -9,5 +9,5 @@ The full per-endpoint records for an image model. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Endpoints` | [][components.ImageEndpoint](../../models/components/imageendpoint.mdx) | ✅ | N/A | | -| `ID` | `string` | ✅ | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file +| `Endpoints` | [][components.ImageEndpoint](../../models/components/imageendpoint.mdx) | :heavy_check_mark: | N/A | | +| `ID` | `string` | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file diff --git a/docs/models/components/imagemodellistitem.mdx b/docs/models/components/imagemodellistitem.mdx index 50200d2b6..8d66095d4 100644 --- a/docs/models/components/imagemodellistitem.mdx +++ b/docs/models/components/imagemodellistitem.mdx @@ -9,11 +9,11 @@ A single image model in the discovery listing. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Architecture` | [components.ImageModelArchitecture](../../models/components/imagemodelarchitecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | -| `Created` | `int64` | ✅ | Unix timestamp (seconds) of when the model was created | 1692901234 | -| `Description` | `string` | ✅ | N/A | A text-to-image model. | -| `Endpoints` | `string` | ✅ | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | -| `ID` | `string` | ✅ | Model slug | bytedance-seed/seedream-4.5 | -| `Name` | `string` | ✅ | Display name | Seedream 4.5 | -| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | ✅ | Union of supported parameters across every endpoint of this model. Coarse discovery aid; the definitive per-endpoint set is behind the endpoints URL. | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | -| `SupportsStreaming` | `bool` | ✅ | Whether any endpoint of this model supports native SSE streaming on the dedicated Image API (i.e. `stream: true` in the request). OR across endpoints. | false | \ No newline at end of file +| `Architecture` | [components.ImageModelArchitecture](../../models/components/imagemodelarchitecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | +| `Created` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) of when the model was created | 1692901234 | +| `Description` | `string` | :heavy_check_mark: | N/A | A text-to-image model. | +| `Endpoints` | `string` | :heavy_check_mark: | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | +| `ID` | `string` | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | +| `Name` | `string` | :heavy_check_mark: | Display name | Seedream 4.5 | +| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | :heavy_check_mark: | Union of supported parameters across every endpoint of this model. Coarse discovery aid; the definitive per-endpoint set is behind the endpoints URL. | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | +| `SupportsStreaming` | `bool` | :heavy_check_mark: | Whether any endpoint of this model supports native SSE streaming on the dedicated Image API (i.e. `stream: true` in the request). OR across endpoints. | false | \ No newline at end of file diff --git a/docs/models/components/imagemodelslistresponse.mdx b/docs/models/components/imagemodelslistresponse.mdx index bd1378de7..234ee1662 100644 --- a/docs/models/components/imagemodelslistresponse.mdx +++ b/docs/models/components/imagemodelslistresponse.mdx @@ -9,4 +9,4 @@ List of image generation models. | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Data` | [][components.ImageModelListItem](../../models/components/imagemodellistitem.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.ImageModelListItem](../../models/components/imagemodellistitem.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagepricingentry.mdx b/docs/models/components/imagepricingentry.mdx index 12feb9b96..e31d3ea6c 100644 --- a/docs/models/components/imagepricingentry.mdx +++ b/docs/models/components/imagepricingentry.mdx @@ -9,7 +9,7 @@ One billable pricing line for an image provider. | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Billable` | [components.Billable](../../models/components/billable.mdx) | ✅ | N/A | -| `CostUsd` | `float64` | ✅ | N/A | -| `Unit` | [components.Unit](../../models/components/unit.mdx) | ✅ | N/A | -| `Variant` | `*string` | ➖ | N/A | \ No newline at end of file +| `Billable` | [components.Billable](../../models/components/billable.mdx) | :heavy_check_mark: | N/A | +| `CostUsd` | `float64` | :heavy_check_mark: | N/A | +| `Unit` | [components.Unit](../../models/components/unit.mdx) | :heavy_check_mark: | N/A | +| `Variant` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagestreamingresponse.mdx b/docs/models/components/imagestreamingresponse.mdx index 56212ecc3..d5aa92cca 100644 --- a/docs/models/components/imagestreamingresponse.mdx +++ b/docs/models/components/imagestreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ImageStreamingResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Data` | [components.ImageStreamingResponseData](../../models/components/imagestreamingresponsedata.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.ImageStreamingResponseData](../../models/components/imagestreamingresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/incompletedetails.mdx b/docs/models/components/incompletedetails.mdx index 3f3e9ea0c..3943c325f 100644 --- a/docs/models/components/incompletedetails.mdx +++ b/docs/models/components/incompletedetails.mdx @@ -6,4 +6,4 @@ title: "IncompleteDetails" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `Reason` | [*components.IncompleteDetailsReason](../../models/components/incompletedetailsreason.mdx) | ➖ | N/A | \ No newline at end of file +| `Reason` | [*components.IncompleteDetailsReason](../../models/components/incompletedetailsreason.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/input1.mdx b/docs/models/components/input1.mdx index db7ace533..98b4ee8ae 100644 --- a/docs/models/components/input1.mdx +++ b/docs/models/components/input1.mdx @@ -6,4 +6,4 @@ title: "Input1" | Field | Type | Required | Description | Example | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `Prompt` | `string` | ✅ | N/A | What is the meaning of life? | \ No newline at end of file +| `Prompt` | `string` | :heavy_check_mark: | N/A | What is the meaning of life? | \ No newline at end of file diff --git a/docs/models/components/input2.mdx b/docs/models/components/input2.mdx index 54f5d77bc..124b13a76 100644 --- a/docs/models/components/input2.mdx +++ b/docs/models/components/input2.mdx @@ -6,4 +6,4 @@ title: "Input2" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `Messages` | []`any` | ✅ | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file +| `Messages` | []`any` | :heavy_check_mark: | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file diff --git a/docs/models/components/inputaudio.mdx b/docs/models/components/inputaudio.mdx index 3e07ec2f3..adb969735 100644 --- a/docs/models/components/inputaudio.mdx +++ b/docs/models/components/inputaudio.mdx @@ -9,5 +9,5 @@ Audio input content item | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `InputAudio` | [components.InputAudioInputAudio](../../models/components/inputaudioinputaudio.mdx) | ✅ | N/A | -| `Type` | [components.InputAudioType](../../models/components/inputaudiotype.mdx) | ✅ | N/A | \ No newline at end of file +| `InputAudio` | [components.InputAudioInputAudio](../../models/components/inputaudioinputaudio.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.InputAudioType](../../models/components/inputaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputaudioinputaudio.mdx b/docs/models/components/inputaudioinputaudio.mdx index 80c8832c5..528acbfb8 100644 --- a/docs/models/components/inputaudioinputaudio.mdx +++ b/docs/models/components/inputaudioinputaudio.mdx @@ -6,5 +6,5 @@ title: "InputAudioInputAudio" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | `string` | ✅ | N/A | -| `Format` | [components.FormatEnum](../../models/components/formatenum.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | N/A | +| `Format` | [components.FormatEnum](../../models/components/formatenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputfile.mdx b/docs/models/components/inputfile.mdx index 41e5d2a0c..68e85f5a5 100644 --- a/docs/models/components/inputfile.mdx +++ b/docs/models/components/inputfile.mdx @@ -9,8 +9,8 @@ File input content item | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `FileData` | `*string` | ➖ | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `FileURL` | `*string` | ➖ | N/A | -| `Filename` | `*string` | ➖ | N/A | -| `Type` | [components.InputFileType](../../models/components/inputfiletype.mdx) | ✅ | N/A | \ No newline at end of file +| `FileData` | `*string` | :heavy_minus_sign: | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `FileURL` | `*string` | :heavy_minus_sign: | N/A | +| `Filename` | `*string` | :heavy_minus_sign: | N/A | +| `Type` | [components.InputFileType](../../models/components/inputfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputimage.mdx b/docs/models/components/inputimage.mdx index 484e55206..0bf10da77 100644 --- a/docs/models/components/inputimage.mdx +++ b/docs/models/components/inputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Detail` | [components.InputImageDetail](../../models/components/inputimagedetail.mdx) | ✅ | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.InputImageType](../../models/components/inputimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `Detail` | [components.InputImageDetail](../../models/components/inputimagedetail.mdx) | :heavy_check_mark: | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.InputImageType](../../models/components/inputimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputimagemask.mdx b/docs/models/components/inputimagemask.mdx index c2f53da00..7da8bba2b 100644 --- a/docs/models/components/inputimagemask.mdx +++ b/docs/models/components/inputimagemask.mdx @@ -6,5 +6,5 @@ title: "InputImageMask" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `FileID` | `*string` | ➖ | N/A | -| `ImageURL` | `*string` | ➖ | N/A | \ No newline at end of file +| `FileID` | `*string` | :heavy_minus_sign: | N/A | +| `ImageURL` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputmessageitem.mdx b/docs/models/components/inputmessageitem.mdx index 45d924321..acd9e0a62 100644 --- a/docs/models/components/inputmessageitem.mdx +++ b/docs/models/components/inputmessageitem.mdx @@ -6,7 +6,7 @@ title: "InputMessageItem" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.InputMessageItemContentUnion](../../models/components/inputmessageitemcontentunion.mdx)] | ➖ | N/A | -| `ID` | `*string` | ➖ | N/A | -| `Role` | [components.InputMessageItemRoleUnion](../../models/components/inputmessageitemroleunion.mdx) | ✅ | N/A | -| `Type` | [*components.InputMessageItemTypeMessage](../../models/components/inputmessageitemtypemessage.mdx) | ➖ | N/A | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[][components.InputMessageItemContentUnion](../../models/components/inputmessageitemcontentunion.mdx)] | :heavy_minus_sign: | N/A | +| `ID` | `*string` | :heavy_minus_sign: | N/A | +| `Role` | [components.InputMessageItemRoleUnion](../../models/components/inputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | +| `Type` | [*components.InputMessageItemTypeMessage](../../models/components/inputmessageitemtypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputmessageitemcontentinputimage.mdx b/docs/models/components/inputmessageitemcontentinputimage.mdx index 0cf5ecffd..6346e65d7 100644 --- a/docs/models/components/inputmessageitemcontentinputimage.mdx +++ b/docs/models/components/inputmessageitemcontentinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.InputMessageItemDetail](../../models/components/inputmessageitemdetail.mdx) | ✅ | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.InputMessageItemTypeInputImage](../../models/components/inputmessageitemtypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file +| `Detail` | [components.InputMessageItemDetail](../../models/components/inputmessageitemdetail.mdx) | :heavy_check_mark: | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.InputMessageItemTypeInputImage](../../models/components/inputmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputschema.mdx b/docs/models/components/inputschema.mdx index 0b22ad2b4..d8ae85d5e 100644 --- a/docs/models/components/inputschema.mdx +++ b/docs/models/components/inputschema.mdx @@ -6,7 +6,7 @@ title: "InputSchema" | Field | Type | Required | Description | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Properties` | `any` | ➖ | N/A | -| `Required` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | -| `Type` | `*string` | ➖ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Properties` | `any` | :heavy_minus_sign: | N/A | +| `Required` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | +| `Type` | `*string` | :heavy_minus_sign: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputsmessage.mdx b/docs/models/components/inputsmessage.mdx index e0398f45f..4bc50ecba 100644 --- a/docs/models/components/inputsmessage.mdx +++ b/docs/models/components/inputsmessage.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InputsContent2](../../models/components/inputscontent2.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.InputsPhaseUnion](../../models/components/inputsphaseunion.mdx)] | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.InputsRole](../../models/components/inputsrole.mdx) | ✅ | N/A | -| `Status` | [*components.InputsStatusUnion1](../../models/components/inputsstatusunion1.mdx) | ➖ | N/A | -| `Type` | [*components.InputsTypeMessage](../../models/components/inputstypemessage.mdx) | ➖ | N/A | \ No newline at end of file +| `Content` | [*components.InputsContent2](../../models/components/inputscontent2.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.InputsPhaseUnion](../../models/components/inputsphaseunion.mdx)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `Role` | [components.InputsRole](../../models/components/inputsrole.mdx) | :heavy_check_mark: | N/A | +| `Status` | [*components.InputsStatusUnion1](../../models/components/inputsstatusunion1.mdx) | :heavy_minus_sign: | N/A | +| `Type` | [*components.InputsTypeMessage](../../models/components/inputstypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputsreasoning.mdx b/docs/models/components/inputsreasoning.mdx index 34615e7c2..d006dc3b6 100644 --- a/docs/models/components/inputsreasoning.mdx +++ b/docs/models/components/inputsreasoning.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | ➖ | N/A | | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Status` | [*components.InputsStatusUnion2](../../models/components/inputsstatusunion2.mdx) | ➖ | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | | -| `Type` | [components.InputsTypeReasoning](../../models/components/inputstypereasoning.mdx) | ✅ | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | -| `Signature` | optionalnullable.OptionalNullable[`string`] | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [*components.InputsStatusUnion2](../../models/components/inputsstatusunion2.mdx) | :heavy_minus_sign: | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.InputsTypeReasoning](../../models/components/inputstypereasoning.mdx) | :heavy_check_mark: | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/components/inputtext.mdx b/docs/models/components/inputtext.mdx index 993c90722..78cd13dcf 100644 --- a/docs/models/components/inputtext.mdx +++ b/docs/models/components/inputtext.mdx @@ -9,6 +9,6 @@ Text input content item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint.mdx)] | ➖ | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | -| `Text` | `string` | ✅ | N/A | | -| `Type` | [components.InputTextType](../../models/components/inputtexttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint.mdx)] | :heavy_minus_sign: | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | +| `Text` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.InputTextType](../../models/components/inputtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/inputtokensdetails.mdx b/docs/models/components/inputtokensdetails.mdx index 2391d48a5..655e5a672 100644 --- a/docs/models/components/inputtokensdetails.mdx +++ b/docs/models/components/inputtokensdetails.mdx @@ -6,5 +6,5 @@ title: "InputTokensDetails" | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | -| `CachedTokens` | `int64` | ✅ | N/A | \ No newline at end of file +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | +| `CachedTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputvideo.mdx b/docs/models/components/inputvideo.mdx index b05c03e31..1865f1363 100644 --- a/docs/models/components/inputvideo.mdx +++ b/docs/models/components/inputvideo.mdx @@ -9,6 +9,6 @@ Video input content item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Processing` | [*components.InputVideoProcessing](../../models/components/inputvideoprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `Type` | [components.InputVideoType](../../models/components/inputvideotype.mdx) | ✅ | N/A | | -| `VideoURL` | `string` | ✅ | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file +| `Processing` | [*components.InputVideoProcessing](../../models/components/inputvideoprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `Type` | [components.InputVideoType](../../models/components/inputvideotype.mdx) | :heavy_check_mark: | N/A | | +| `VideoURL` | `string` | :heavy_check_mark: | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file diff --git a/docs/models/components/intern.mdx b/docs/models/components/intern.mdx index ef9b504d2..58dbfefb4 100644 --- a/docs/models/components/intern.mdx +++ b/docs/models/components/intern.mdx @@ -9,17 +9,17 @@ Public lifecycle state and settings for one intern. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `AttachedVaultID` | `*string` | ✅ | Vault the intern borrows from another intern, or null when it borrows none. | -| `CreatedAt` | `string` | ✅ | ISO 8601 creation time. | -| `Description` | `*string` | ✅ | Free-form description. | -| `Hostname` | `*string` | ✅ | Public hostname the intern is reachable at, or null until provisioning has assigned one. | -| `ID` | `string` | ✅ | Intern id. | -| `Instructions` | `*string` | ✅ | Standing instructions the intern boots with. | -| `LastFailureMessage` | `*string` | ✅ | Why the last provisioning attempt failed, when status is failed. | -| `Model` | `*string` | ✅ | OpenRouter model slug the intern runs, or null for the workspace default. | -| `Name` | `string` | ✅ | Intern name, unique per creator within a workspace. | -| `Progress` | [*components.Progress](../../models/components/progress.mdx) | ✅ | Active provisioning step, or null once provisioning has settled. | -| `Status` | [components.InternStatus](../../models/components/internstatus.mdx) | ✅ | Lifecycle status. | -| `UpdatedAt` | `string` | ✅ | ISO 8601 last update time. | -| `VaultID` | `*string` | ✅ | Vault the intern owns, or null before it has been created. | -| `WorkspaceID` | `string` | ✅ | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file +| `AttachedVaultID` | `*string` | :heavy_check_mark: | Vault the intern borrows from another intern, or null when it borrows none. | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 creation time. | +| `Description` | `*string` | :heavy_check_mark: | Free-form description. | +| `Hostname` | `*string` | :heavy_check_mark: | Public hostname the intern is reachable at, or null until provisioning has assigned one. | +| `ID` | `string` | :heavy_check_mark: | Intern id. | +| `Instructions` | `*string` | :heavy_check_mark: | Standing instructions the intern boots with. | +| `LastFailureMessage` | `*string` | :heavy_check_mark: | Why the last provisioning attempt failed, when status is failed. | +| `Model` | `*string` | :heavy_check_mark: | OpenRouter model slug the intern runs, or null for the workspace default. | +| `Name` | `string` | :heavy_check_mark: | Intern name, unique per creator within a workspace. | +| `Progress` | [*components.Progress](../../models/components/progress.mdx) | :heavy_check_mark: | Active provisioning step, or null once provisioning has settled. | +| `Status` | [components.InternStatus](../../models/components/internstatus.mdx) | :heavy_check_mark: | Lifecycle status. | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO 8601 last update time. | +| `VaultID` | `*string` | :heavy_check_mark: | Vault the intern owns, or null before it has been created. | +| `WorkspaceID` | `string` | :heavy_check_mark: | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file diff --git a/docs/models/components/internalserverresponseerrordata.mdx b/docs/models/components/internalserverresponseerrordata.mdx index 6b89dcbcb..7af4937fc 100644 --- a/docs/models/components/internalserverresponseerrordata.mdx +++ b/docs/models/components/internalserverresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for InternalServerResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/internchatassistantmessage.mdx b/docs/models/components/internchatassistantmessage.mdx index 0573a033c..9acf19ded 100644 --- a/docs/models/components/internchatassistantmessage.mdx +++ b/docs/models/components/internchatassistantmessage.mdx @@ -9,6 +9,6 @@ An assistant message from an earlier response. When answering an interaction, ec | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx)] | ➖ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatAssistantMessageRole](../../models/components/internchatassistantmessagerole.mdx) | ✅ | N/A | | -| `ToolCalls` | [][components.InternChatEchoedToolCall](../../models/components/internchatechoedtoolcall.mdx) | ➖ | N/A | | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx)] | :heavy_minus_sign: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatAssistantMessageRole](../../models/components/internchatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `ToolCalls` | [][components.InternChatEchoedToolCall](../../models/components/internchatechoedtoolcall.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatchoice.mdx b/docs/models/components/internchatchoice.mdx index 8ea4214f2..664c706b9 100644 --- a/docs/models/components/internchatchoice.mdx +++ b/docs/models/components/internchatchoice.mdx @@ -9,6 +9,6 @@ The single choice this endpoint streams. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Delta` | [components.InternChatDelta](../../models/components/internchatdelta.mdx) | ✅ | The incremental content of one chunk. The first chunk carries `role`, text chunks carry `content`, reasoning chunks carry `reasoning`, and an interaction chunk carries one complete `tool_calls` entry. | \{
"content": "Hello"
} | -| `FinishReason` | [*components.InternChatChoiceFinishReason](../../models/components/internchatchoicefinishreason.mdx) | ✅ | `null` while streaming. `stop` when the run completed, `tool_calls` when the run is waiting for the caller to answer the streamed tool call, `error` on the terminal error chunk. | | -| `Index` | `int64` | ✅ | N/A | | \ No newline at end of file +| `Delta` | [components.InternChatDelta](../../models/components/internchatdelta.mdx) | :heavy_check_mark: | The incremental content of one chunk. The first chunk carries `role`, text chunks carry `content`, reasoning chunks carry `reasoning`, and an interaction chunk carries one complete `tool_calls` entry. | \{
"content": "Hello"
} | +| `FinishReason` | [*components.InternChatChoiceFinishReason](../../models/components/internchatchoicefinishreason.mdx) | :heavy_check_mark: | `null` while streaming. `stop` when the run completed, `tool_calls` when the run is waiting for the caller to answer the streamed tool call, `error` on the terminal error chunk. | | +| `Index` | `int64` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatcompletionchunk.mdx b/docs/models/components/internchatcompletionchunk.mdx index 99f29517e..dab91c511 100644 --- a/docs/models/components/internchatcompletionchunk.mdx +++ b/docs/models/components/internchatcompletionchunk.mdx @@ -9,11 +9,11 @@ One `data:` line of the stream. A run streams a role chunk, content and reasonin | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.InternChatChoice](../../models/components/internchatchoice.mdx) | ✅ | One choice on content, tool-call and error chunks. Empty on the final chunk that carries `session_id`. | | -| `Created` | `int64` | ✅ | N/A | | -| `Error` | [*components.InternChatStreamError](../../models/components/internchatstreamerror.mdx) | ➖ | A failure after the response headers were sent. The chunk that carries it has `finish_reason: "error"`, then the final empty-`choices` chunk and `[DONE]` follow. Reasons here are `attachment_failed`, `busy`, `client_closed_request`, `interaction_not_pending`, `interaction_unknown`, `intern_unreachable`, `run_ended`, `stream_severed`, `timeout` or `turn_failed`. `run_ended` reports an ending the intern confirmed, such as a cancellation or a deadline, while `stream_severed` reports a connection lost without that confirmation. | \{
"code": 502,
"message": "The intern could not continue this run.",
"metadata": \{
"reason": "attachment_failed",
"retryable": false
}
} | -| `ID` | `string` | ✅ | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | -| `Model` | `string` | ✅ | The runtime's identifier for the model the intern is running, as the intern reports it. Each chunk carries the model from the event behind it: `openrouter/intern` on chunks emitted before the intern has reported one and on chunks the API emits itself (timeout, run-ended and severed-stream errors and their final usage chunk), even after an earlier chunk named a model. It can change within a stream. It is not an OpenRouter model slug, and the request `model` is never used. | | -| `Object` | [components.InternChatCompletionChunkObject](../../models/components/internchatcompletionchunkobject.mdx) | ✅ | N/A | | -| `SessionID` | optionalnullable.OptionalNullable[`string`] | ➖ | On the final chunk of every response, the daemon session to continue with, or `null` when the run failed before the intern reported one. Send it as `session_id` on the next request, including the `tool` reply to an interaction. Session ids are client-visible and scoped to the intern's own daemon. | ses_7f3c9a | -| `Usage` | optionalnullable.OptionalNullable[[components.InternChatUsage](../../models/components/internchatusage.mdx)] | ➖ | Token usage for the run as the daemon reported it, on the final chunk before `[DONE]`. `null` when the daemon reported none, and always `null` after `tool_calls` because the turn is not over. | \{
"completion_tokens": 12,
"prompt_tokens": 40,
"total_tokens": 52
} | \ No newline at end of file +| `Choices` | [][components.InternChatChoice](../../models/components/internchatchoice.mdx) | :heavy_check_mark: | One choice on content, tool-call and error chunks. Empty on the final chunk that carries `session_id`. | | +| `Created` | `int64` | :heavy_check_mark: | N/A | | +| `Error` | [*components.InternChatStreamError](../../models/components/internchatstreamerror.mdx) | :heavy_minus_sign: | A failure after the response headers were sent. The chunk that carries it has `finish_reason: "error"`, then the final empty-`choices` chunk and `[DONE]` follow. Reasons here are `attachment_failed`, `busy`, `client_closed_request`, `interaction_not_pending`, `interaction_unknown`, `intern_unreachable`, `run_ended`, `stream_severed`, `timeout` or `turn_failed`. `run_ended` reports an ending the intern confirmed, such as a cancellation or a deadline, while `stream_severed` reports a connection lost without that confirmation. | \{
"code": 502,
"message": "The intern could not continue this run.",
"metadata": \{
"reason": "attachment_failed",
"retryable": false
}
} | +| `ID` | `string` | :heavy_check_mark: | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | +| `Model` | `string` | :heavy_check_mark: | The runtime's identifier for the model the intern is running, as the intern reports it. Each chunk carries the model from the event behind it: `openrouter/intern` on chunks emitted before the intern has reported one and on chunks the API emits itself (timeout, run-ended and severed-stream errors and their final usage chunk), even after an earlier chunk named a model. It can change within a stream. It is not an OpenRouter model slug, and the request `model` is never used. | | +| `Object` | [components.InternChatCompletionChunkObject](../../models/components/internchatcompletionchunkobject.mdx) | :heavy_check_mark: | N/A | | +| `SessionID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | On the final chunk of every response, the daemon session to continue with, or `null` when the run failed before the intern reported one. Send it as `session_id` on the next request, including the `tool` reply to an interaction. Session ids are client-visible and scoped to the intern's own daemon. | ses_7f3c9a | +| `Usage` | optionalnullable.OptionalNullable[[components.InternChatUsage](../../models/components/internchatusage.mdx)] | :heavy_minus_sign: | Token usage for the run as the daemon reported it, on the final chunk before `[DONE]`. `null` when the daemon reported none, and always `null` after `tool_calls` because the turn is not over. | \{
"completion_tokens": 12,
"prompt_tokens": 40,
"total_tokens": 52
} | \ No newline at end of file diff --git a/docs/models/components/internchatcompletionrequest.mdx b/docs/models/components/internchatcompletionrequest.mdx index 6dca3519a..9c38d1be4 100644 --- a/docs/models/components/internchatcompletionrequest.mdx +++ b/docs/models/components/internchatcompletionrequest.mdx @@ -9,8 +9,8 @@ An OpenAI-compatible streaming chat completion request for one intern. Other Ope | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ApprovalMode` | [*components.InternApprovalMode](../../models/components/internapprovalmode.mdx) | ➖ | How the run started by this prompt handles tool approvals. `self-drive` (the default when omitted) consents on your behalf and runs the shell unsandboxed. `manual` asks you before an approval-bearing tool runs, as an `openrouter.provide_input` permission request, and keeps the shell sandboxed until an escalation is allowed. The mode applies to the run this prompt starts and is not remembered by the session. Repeat it on each new prompt that should use it. A `tool` reply continues the run under the mode it started with. | manual | -| `Messages` | [][components.InternChatMessage](../../models/components/internchatmessage.mdx) | ✅ | The conversation. Only the last message is read. A last `user` message starts a run. A last `tool` message answers the interaction named by its `tool_call_id` and requires `session_id`. | | -| `Model` | `*string` | ➖ | Accepted for OpenAI compatibility and never used. The intern runs the model configured on it (`PATCH` the intern to change it). Streamed chunks report the runtime's identifier for that model as the intern reports it, or `openrouter/intern` on chunks whose event carries no model (before the intern reports one, and on the chunks the API emits itself: the timeout, run-ended and severed-stream error chunks, the stop chunk of a replay that ends without a terminal daemon event, and the final usage chunk after any of them). A usage chunk that follows a daemon completion event carries the model the intern reported. | openrouter/intern | -| `SessionID` | `*string` | ➖ | The daemon session to continue, as returned in `session_id` on the final chunk of an earlier response. Omit it to start a new session. An id the intern has not seen before is not an error: it starts a new session under that id, so a mistyped id forks the conversation. Sessions are scoped to the intern's own daemon. Required when the last message has role `tool`. | ses_7f3c9a | -| `Stream` | `bool` | ✅ | Must be `true`. This endpoint only streams. `false` or an omitted `stream` is refused with `400` and reason `bad_request`. | true | \ No newline at end of file +| `ApprovalMode` | [*components.InternApprovalMode](../../models/components/internapprovalmode.mdx) | :heavy_minus_sign: | How the run started by this prompt handles tool approvals. `self-drive` (the default when omitted) consents on your behalf and runs the shell unsandboxed. `manual` asks you before an approval-bearing tool runs, as an `openrouter.provide_input` permission request, and keeps the shell sandboxed until an escalation is allowed. The mode applies to the run this prompt starts and is not remembered by the session. Repeat it on each new prompt that should use it. A `tool` reply continues the run under the mode it started with. | manual | +| `Messages` | [][components.InternChatMessage](../../models/components/internchatmessage.mdx) | :heavy_check_mark: | The conversation. Only the last message is read. A last `user` message starts a run. A last `tool` message answers the interaction named by its `tool_call_id` and requires `session_id`. | | +| `Model` | `*string` | :heavy_minus_sign: | Accepted for OpenAI compatibility and never used. The intern runs the model configured on it (`PATCH` the intern to change it). Streamed chunks report the runtime's identifier for that model as the intern reports it, or `openrouter/intern` on chunks whose event carries no model (before the intern reports one, and on the chunks the API emits itself: the timeout, run-ended and severed-stream error chunks, the stop chunk of a replay that ends without a terminal daemon event, and the final usage chunk after any of them). A usage chunk that follows a daemon completion event carries the model the intern reported. | openrouter/intern | +| `SessionID` | `*string` | :heavy_minus_sign: | The daemon session to continue, as returned in `session_id` on the final chunk of an earlier response. Omit it to start a new session. An id the intern has not seen before is not an error: it starts a new session under that id, so a mistyped id forks the conversation. Sessions are scoped to the intern's own daemon. Required when the last message has role `tool`. | ses_7f3c9a | +| `Stream` | `bool` | :heavy_check_mark: | Must be `true`. This endpoint only streams. `false` or an omitted `stream` is refused with `400` and reason `bad_request`. | true | \ No newline at end of file diff --git a/docs/models/components/internchatdelta.mdx b/docs/models/components/internchatdelta.mdx index 986066422..b74777050 100644 --- a/docs/models/components/internchatdelta.mdx +++ b/docs/models/components/internchatdelta.mdx @@ -9,7 +9,7 @@ The incremental content of one chunk. The first chunk carries `role`, text chunk | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `Content` | `*string` | ➖ | N/A | -| `Reasoning` | `*string` | ➖ | N/A | -| `Role` | [*components.InternChatDeltaRole](../../models/components/internchatdeltarole.mdx) | ➖ | N/A | -| `ToolCalls` | [][components.InternChatToolCall](../../models/components/internchattoolcall.mdx) | ➖ | N/A | \ No newline at end of file +| `Content` | `*string` | :heavy_minus_sign: | N/A | +| `Reasoning` | `*string` | :heavy_minus_sign: | N/A | +| `Role` | [*components.InternChatDeltaRole](../../models/components/internchatdeltarole.mdx) | :heavy_minus_sign: | N/A | +| `ToolCalls` | [][components.InternChatToolCall](../../models/components/internchattoolcall.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/internchatdevelopermessage.mdx b/docs/models/components/internchatdevelopermessage.mdx index 95de73992..183ab668b 100644 --- a/docs/models/components/internchatdevelopermessage.mdx +++ b/docs/models/components/internchatdevelopermessage.mdx @@ -9,5 +9,5 @@ A developer message. Accepted for client compatibility and not forwarded. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatDeveloperMessageRole](../../models/components/internchatdevelopermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatDeveloperMessageRole](../../models/components/internchatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatechoedtoolcall.mdx b/docs/models/components/internchatechoedtoolcall.mdx index 5b8c815e9..2b254f11a 100644 --- a/docs/models/components/internchatechoedtoolcall.mdx +++ b/docs/models/components/internchatechoedtoolcall.mdx @@ -9,5 +9,5 @@ The `openrouter.provide_input` tool call from the previous response, echoed back | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Function` | [components.InternChatEchoedToolCallFunction](../../models/components/internchatechoedtoolcallfunction.mdx) | ✅ | The function name and JSON arguments string exactly as streamed. | \{
"arguments": "\{\"kind\":\"permission\",\"operation\":\"shell\",\"options\":[\"allow_once\",\"reject_once\"]}",
"name": "openrouter.provide_input"
} | -| `ID` | `string` | ✅ | N/A | | \ No newline at end of file +| `Function` | [components.InternChatEchoedToolCallFunction](../../models/components/internchatechoedtoolcallfunction.mdx) | :heavy_check_mark: | The function name and JSON arguments string exactly as streamed. | \{
"arguments": "\{\"kind\":\"permission\",\"operation\":\"shell\",\"options\":[\"allow_once\",\"reject_once\"]}",
"name": "openrouter.provide_input"
} | +| `ID` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatechoedtoolcallfunction.mdx b/docs/models/components/internchatechoedtoolcallfunction.mdx index 60262455b..f6ab40d5b 100644 --- a/docs/models/components/internchatechoedtoolcallfunction.mdx +++ b/docs/models/components/internchatechoedtoolcallfunction.mdx @@ -9,5 +9,5 @@ The function name and JSON arguments string exactly as streamed. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Arguments` | `string` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/internchaterror.mdx b/docs/models/components/internchaterror.mdx index 00fadbd21..b73e6a466 100644 --- a/docs/models/components/internchaterror.mdx +++ b/docs/models/components/internchaterror.mdx @@ -9,6 +9,6 @@ The OpenAI-compatible error object. `metadata` is present on refusals from the c | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `Code` | `int64` | ✅ | The HTTP status of the response. | | -| `Message` | `string` | ✅ | N/A | | -| `Metadata` | [*components.InternChatErrorMetadata](../../models/components/internchaterrormetadata.mdx) | ➖ | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | The HTTP status of the response. | | +| `Message` | `string` | :heavy_check_mark: | N/A | | +| `Metadata` | [*components.InternChatErrorMetadata](../../models/components/internchaterrormetadata.mdx) | :heavy_minus_sign: | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file diff --git a/docs/models/components/internchaterrormetadata.mdx b/docs/models/components/internchaterrormetadata.mdx index cdc24eeaf..12f6a72ad 100644 --- a/docs/models/components/internchaterrormetadata.mdx +++ b/docs/models/components/internchaterrormetadata.mdx @@ -9,5 +9,5 @@ Machine-readable detail for the failure. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Reason` | [components.InternChatErrorMetadataReason](../../models/components/internchaterrormetadatareason.mdx) | ✅ | A stable reason a client can branch on. | -| `Retryable` | `bool` | ✅ | Whether the same request may be sent again unchanged. Always `true` for the transient refusals — `busy`, `intern_not_ready`, `intern_unreachable`, `rate_limited`, `stream_severed` and `timeout` — and always `false` for the ones a retry cannot fix. For `turn_failed` it varies by failure and is the intern's own classification of what went wrong: `true` for an upstream overload, rate limit, timeout or transport fault, `false` for an authentication or bad-request failure that would be rejected the same way again. Branch on this field rather than on `reason` when deciding whether to retry. A `429`, and a `409` or `503` with reason `busy`, also carry a `Retry-After` header saying how long to wait. | \ No newline at end of file +| `Reason` | [components.InternChatErrorMetadataReason](../../models/components/internchaterrormetadatareason.mdx) | :heavy_check_mark: | A stable reason a client can branch on. | +| `Retryable` | `bool` | :heavy_check_mark: | Whether the same request may be sent again unchanged. Always `true` for the transient refusals — `busy`, `intern_not_ready`, `intern_unreachable`, `rate_limited`, `stream_severed` and `timeout` — and always `false` for the ones a retry cannot fix. For `turn_failed` it varies by failure and is the intern's own classification of what went wrong: `true` for an upstream overload, rate limit, timeout or transport fault, `false` for an authentication or bad-request failure that would be rejected the same way again. Branch on this field rather than on `reason` when deciding whether to retry. A `429`, and a `409` or `503` with reason `busy`, also carry a `Retry-After` header saying how long to wait. | \ No newline at end of file diff --git a/docs/models/components/internchatprompttokensdetails.mdx b/docs/models/components/internchatprompttokensdetails.mdx index 0dc3e9568..681587878 100644 --- a/docs/models/components/internchatprompttokensdetails.mdx +++ b/docs/models/components/internchatprompttokensdetails.mdx @@ -9,4 +9,4 @@ Prompt tokens served from cache, when the daemon reported them. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `CachedTokens` | `int64` | ✅ | N/A | \ No newline at end of file +| `CachedTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/internchatsteeredresponse.mdx b/docs/models/components/internchatsteeredresponse.mdx index 2b13fca49..506e62b4d 100644 --- a/docs/models/components/internchatsteeredresponse.mdx +++ b/docs/models/components/internchatsteeredresponse.mdx @@ -9,5 +9,5 @@ The message was delivered into the turn already running on the same session. Its | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `SessionID` | `string` | ✅ | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | -| `Status` | [components.InternChatSteeredResponseStatus](../../models/components/internchatsteeredresponsestatus.mdx) | ✅ | The message was handed to the turn already running on this session. | | \ No newline at end of file +| `SessionID` | `string` | :heavy_check_mark: | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | +| `Status` | [components.InternChatSteeredResponseStatus](../../models/components/internchatsteeredresponsestatus.mdx) | :heavy_check_mark: | The message was handed to the turn already running on this session. | | \ No newline at end of file diff --git a/docs/models/components/internchatstreamerror.mdx b/docs/models/components/internchatstreamerror.mdx index 14c60e0c9..35cd71166 100644 --- a/docs/models/components/internchatstreamerror.mdx +++ b/docs/models/components/internchatstreamerror.mdx @@ -9,6 +9,6 @@ A failure after the response headers were sent. The chunk that carries it has `f | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Code` | `int64` | ✅ | The HTTP status this failure would have had before the stream opened. | | -| `Message` | `string` | ✅ | N/A | | -| `Metadata` | [components.InternChatErrorMetadata](../../models/components/internchaterrormetadata.mdx) | ✅ | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | The HTTP status this failure would have had before the stream opened. | | +| `Message` | `string` | :heavy_check_mark: | N/A | | +| `Metadata` | [components.InternChatErrorMetadata](../../models/components/internchaterrormetadata.mdx) | :heavy_check_mark: | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file diff --git a/docs/models/components/internchatstreamingresponse.mdx b/docs/models/components/internchatstreamingresponse.mdx index 8cbc551c8..2b7d37d8a 100644 --- a/docs/models/components/internchatstreamingresponse.mdx +++ b/docs/models/components/internchatstreamingresponse.mdx @@ -9,4 +9,4 @@ A server-sent event carrying one chunk. The stream ends with `data: [DONE]`. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.InternChatCompletionChunk](../../models/components/internchatcompletionchunk.mdx) | ✅ | One `data:` line of the stream. A run streams a role chunk, content and reasoning chunks, then a finish chunk: `stop`, `tool_calls` (the run is paused for input) or `error` (with an `error` object). A final chunk with empty `choices` follows in every case, carrying `session_id` and `usage` (`null` unless the daemon reported usage, and always `null` after `tool_calls`). Every stream ends with `[DONE]`. | \{
"choices": [
\{
"delta": \{
"content": "Hello"
},
"finish_reason": null,
"index": 0
}
],
"created": 1789537541,
"id": "chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750",
"model": "openrouter/intern",
"object": "chat.completion.chunk"
} | \ No newline at end of file +| `Data` | [components.InternChatCompletionChunk](../../models/components/internchatcompletionchunk.mdx) | :heavy_check_mark: | One `data:` line of the stream. A run streams a role chunk, content and reasoning chunks, then a finish chunk: `stop`, `tool_calls` (the run is paused for input) or `error` (with an `error` object). A final chunk with empty `choices` follows in every case, carrying `session_id` and `usage` (`null` unless the daemon reported usage, and always `null` after `tool_calls`). Every stream ends with `[DONE]`. | \{
"choices": [
\{
"delta": \{
"content": "Hello"
},
"finish_reason": null,
"index": 0
}
],
"created": 1789537541,
"id": "chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750",
"model": "openrouter/intern",
"object": "chat.completion.chunk"
} | \ No newline at end of file diff --git a/docs/models/components/internchatsystemmessage.mdx b/docs/models/components/internchatsystemmessage.mdx index da557ec4c..3f205342c 100644 --- a/docs/models/components/internchatsystemmessage.mdx +++ b/docs/models/components/internchatsystemmessage.mdx @@ -9,5 +9,5 @@ A system message. Accepted for client compatibility and not forwarded. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatSystemMessageRole](../../models/components/internchatsystemmessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatSystemMessageRole](../../models/components/internchatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchattextpart.mdx b/docs/models/components/internchattextpart.mdx index 438c3b0d8..e2e867c9e 100644 --- a/docs/models/components/internchattextpart.mdx +++ b/docs/models/components/internchattextpart.mdx @@ -9,5 +9,5 @@ One text part of a message. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.InternChatTextPartType](../../models/components/internchattextparttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.InternChatTextPartType](../../models/components/internchattextparttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/internchattoolcall.mdx b/docs/models/components/internchattoolcall.mdx index e10a27058..f66825e7d 100644 --- a/docs/models/components/internchattoolcall.mdx +++ b/docs/models/components/internchattoolcall.mdx @@ -9,7 +9,7 @@ An `openrouter.provide_input` request. The run pauses on the daemon until a `too | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Function` | [components.InternChatToolCallFunction](../../models/components/internchattoolcallfunction.mdx) | ✅ | The single tool this endpoint calls, asking the caller for input. | \{
"arguments": "\{\"fields\":[\{\"name\":\"answer\",\"options\":[\"red\",\"blue\",\"Other\"],\"required\":true,\"type\":\"string\"}],\"kind\":\"elicitation\",\"message\":\"Which colour do you prefer?\"}",
"name": "openrouter.provide_input"
} | -| `ID` | `string` | ✅ | The interaction id. Send it back as `tool_call_id` on the `tool` message that answers it. | 15e90ad6-5320-4a59-af4f-b371428154fa | -| `Index` | `int64` | ✅ | N/A | | -| `Type` | [components.InternChatToolCallType](../../models/components/internchattoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Function` | [components.InternChatToolCallFunction](../../models/components/internchattoolcallfunction.mdx) | :heavy_check_mark: | The single tool this endpoint calls, asking the caller for input. | \{
"arguments": "\{\"fields\":[\{\"name\":\"answer\",\"options\":[\"red\",\"blue\",\"Other\"],\"required\":true,\"type\":\"string\"}],\"kind\":\"elicitation\",\"message\":\"Which colour do you prefer?\"}",
"name": "openrouter.provide_input"
} | +| `ID` | `string` | :heavy_check_mark: | The interaction id. Send it back as `tool_call_id` on the `tool` message that answers it. | 15e90ad6-5320-4a59-af4f-b371428154fa | +| `Index` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.InternChatToolCallType](../../models/components/internchattoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchattoolcallfunction.mdx b/docs/models/components/internchattoolcallfunction.mdx index fce692e58..8e744a96c 100644 --- a/docs/models/components/internchattoolcallfunction.mdx +++ b/docs/models/components/internchattoolcallfunction.mdx @@ -9,5 +9,5 @@ The single tool this endpoint calls, asking the caller for input. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | ✅ | A JSON object string describing the interaction. A permission request is `{"kind":"permission","operation":,"options":[]}`. A question is `{"kind":"elicitation","message":,"fields":[]}`. | \{"fields":[\{"name":"answer","options":["red","blue","Other"],"required":true,"type":"string"}],"kind":"elicitation","message":"Which colour do you prefer?"} | -| `Name` | [components.InternChatToolCallFunctionName](../../models/components/internchattoolcallfunctionname.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | A JSON object string describing the interaction. A permission request is `{"kind":"permission","operation":,"options":[]}`. A question is `{"kind":"elicitation","message":,"fields":[]}`. | \{"fields":[\{"name":"answer","options":["red","blue","Other"],"required":true,"type":"string"}],"kind":"elicitation","message":"Which colour do you prefer?"} | +| `Name` | [components.InternChatToolCallFunctionName](../../models/components/internchattoolcallfunctionname.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchattoolmessage.mdx b/docs/models/components/internchattoolmessage.mdx index 9e6a1e9e9..50f79e2fe 100644 --- a/docs/models/components/internchattoolmessage.mdx +++ b/docs/models/components/internchattoolmessage.mdx @@ -9,6 +9,6 @@ The answer to an `openrouter.provide_input` tool call. `tool_call_id` is the str | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatToolMessageRole](../../models/components/internchattoolmessagerole.mdx) | ✅ | N/A | | -| `ToolCallID` | `string` | ✅ | N/A | | \ No newline at end of file +| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatToolMessageRole](../../models/components/internchattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `ToolCallID` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatusage.mdx b/docs/models/components/internchatusage.mdx index ee3eb3173..093de080a 100644 --- a/docs/models/components/internchatusage.mdx +++ b/docs/models/components/internchatusage.mdx @@ -9,8 +9,8 @@ Token usage for the run as the daemon reported it, on the final chunk before `[D | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `CompletionTokens` | `int64` | ✅ | N/A | | -| `Cost` | `*float64` | ➖ | The cost of the run in USD, when the daemon reported one. | | -| `PromptTokens` | `int64` | ✅ | N/A | | -| `PromptTokensDetails` | [*components.InternChatPromptTokensDetails](../../models/components/internchatprompttokensdetails.mdx) | ➖ | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | -| `TotalTokens` | `int64` | ✅ | N/A | | \ No newline at end of file +| `CompletionTokens` | `int64` | :heavy_check_mark: | N/A | | +| `Cost` | `*float64` | :heavy_minus_sign: | The cost of the run in USD, when the daemon reported one. | | +| `PromptTokens` | `int64` | :heavy_check_mark: | N/A | | +| `PromptTokensDetails` | [*components.InternChatPromptTokensDetails](../../models/components/internchatprompttokensdetails.mdx) | :heavy_minus_sign: | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | +| `TotalTokens` | `int64` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatusermessage.mdx b/docs/models/components/internchatusermessage.mdx index 312c5c1a8..f76615f96 100644 --- a/docs/models/components/internchatusermessage.mdx +++ b/docs/models/components/internchatusermessage.mdx @@ -9,5 +9,5 @@ A user message. When it is the last message its text is the prompt for a new run | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatUserMessageRole](../../models/components/internchatusermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file +| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatUserMessageRole](../../models/components/internchatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/interndaemonaccess.mdx b/docs/models/components/interndaemonaccess.mdx index 38f25295d..bdfb79acc 100644 --- a/docs/models/components/interndaemonaccess.mdx +++ b/docs/models/components/interndaemonaccess.mdx @@ -9,5 +9,5 @@ The intern daemon's origin and the bearer `ori tui --host` sends to it as `ORI_D | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Origin` | `string` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | \ No newline at end of file +| `Origin` | `string` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/interninvokeacceptedresponse.mdx b/docs/models/components/interninvokeacceptedresponse.mdx index 9dfccef39..f8b0aa688 100644 --- a/docs/models/components/interninvokeacceptedresponse.mdx +++ b/docs/models/components/interninvokeacceptedresponse.mdx @@ -9,5 +9,5 @@ The intern admitted the prompt. The run continues on the intern. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `SessionID` | `string` | ✅ | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | -| `Status` | [components.InternInvokeAcceptedResponseStatus](../../models/components/interninvokeacceptedresponsestatus.mdx) | ✅ | `started` when a new run began. `steered` when the session already had a run going and the prompt was delivered into it instead. | started | \ No newline at end of file +| `SessionID` | `string` | :heavy_check_mark: | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | +| `Status` | [components.InternInvokeAcceptedResponseStatus](../../models/components/interninvokeacceptedresponsestatus.mdx) | :heavy_check_mark: | `started` when a new run began. `steered` when the session already had a run going and the prompt was delivered into it instead. | started | \ No newline at end of file diff --git a/docs/models/components/interninvokerequest.mdx b/docs/models/components/interninvokerequest.mdx index 6ae916f9e..41ce15005 100644 --- a/docs/models/components/interninvokerequest.mdx +++ b/docs/models/components/interninvokerequest.mdx @@ -9,5 +9,5 @@ A prompt to run on the intern without holding a connection open. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Input` | `string` | ✅ | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | -| `SessionID` | `*string` | ➖ | The session to run in. Send the `session_id` from an earlier `202` to continue that conversation, for example to hand the intern a decision on a case it is working. Omit it to start a new session. Only a `session_id` this endpoint issued to the same caller on the same intern is accepted; any other is refused with `404`. | b51a0e21-368b-4780-a220-14655bf28c55 | \ No newline at end of file +| `Input` | `string` | :heavy_check_mark: | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | +| `SessionID` | `*string` | :heavy_minus_sign: | The session to run in. Send the `session_id` from an earlier `202` to continue that conversation, for example to hand the intern a decision on a case it is working. Omit it to start a new session. Only a `session_id` this endpoint issued to the same caller on the same intern is accepted; any other is refused with `404`. | b51a0e21-368b-4780-a220-14655bf28c55 | \ No newline at end of file diff --git a/docs/models/components/internlifecycleerrorerror.mdx b/docs/models/components/internlifecycleerrorerror.mdx index 8b52aca5d..5007be038 100644 --- a/docs/models/components/internlifecycleerrorerror.mdx +++ b/docs/models/components/internlifecycleerrorerror.mdx @@ -6,6 +6,6 @@ title: "InternLifecycleErrorError" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Code` | [components.Code](../../models/components/code.mdx) | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | [*components.InternLifecycleErrorMetadata](../../models/components/internlifecycleerrormetadata.mdx) | ➖ | N/A | \ No newline at end of file +| `Code` | [components.Code](../../models/components/code.mdx) | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | [*components.InternLifecycleErrorMetadata](../../models/components/internlifecycleerrormetadata.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/internlifecycleerrormetadata.mdx b/docs/models/components/internlifecycleerrormetadata.mdx index f4f92c755..f62c41b9c 100644 --- a/docs/models/components/internlifecycleerrormetadata.mdx +++ b/docs/models/components/internlifecycleerrormetadata.mdx @@ -6,5 +6,5 @@ title: "InternLifecycleErrorMetadata" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Reason` | `string` | ✅ | N/A | -| `Retryable` | `bool` | ✅ | N/A | \ No newline at end of file +| `Reason` | `string` | :heavy_check_mark: | N/A | +| `Retryable` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/internlistresponse.mdx b/docs/models/components/internlistresponse.mdx index 1f722dadd..5b8d261a0 100644 --- a/docs/models/components/internlistresponse.mdx +++ b/docs/models/components/internlistresponse.mdx @@ -9,6 +9,6 @@ Interns visible to the authenticated API key. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Data` | [][components.Intern](../../models/components/intern.mdx) | ✅ | N/A | | -| `HasMore` | `bool` | ✅ | True when more interns match the current filters. | | -| `NextCursor` | `*string` | ➖ | Opaque cursor, present when `has_more` is true. Pass it as `starting_after` to fetch the next page. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | \ No newline at end of file +| `Data` | [][components.Intern](../../models/components/intern.mdx) | :heavy_check_mark: | N/A | | +| `HasMore` | `bool` | :heavy_check_mark: | True when more interns match the current filters. | | +| `NextCursor` | `*string` | :heavy_minus_sign: | Opaque cursor, present when `has_more` is true. Pass it as `starting_after` to fetch the next page. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | \ No newline at end of file diff --git a/docs/models/components/itemreferenceitem.mdx b/docs/models/components/itemreferenceitem.mdx index 2afb482f6..8f066bd2f 100644 --- a/docs/models/components/itemreferenceitem.mdx +++ b/docs/models/components/itemreferenceitem.mdx @@ -9,5 +9,5 @@ A reference to a previous response item by ID | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ID` | `string` | ✅ | N/A | -| `Type` | [components.ItemReferenceItemType](../../models/components/itemreferenceitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ItemReferenceItemType](../../models/components/itemreferenceitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/jevrouterplugin.mdx b/docs/models/components/jevrouterplugin.mdx index 334c7b027..da7aee03d 100644 --- a/docs/models/components/jevrouterplugin.mdx +++ b/docs/models/components/jevrouterplugin.mdx @@ -6,8 +6,8 @@ title: "JevRouterPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | []`string` | ➖ | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | -| `CostTier` | `*string` | ➖ | Select low, medium, high, or a cost tier configured by the operator. Overrides the live-config tier and replaces the shared routing policy with that tier. Omit to use the live configuration. Model exclusions and the router kill switch still apply. | medium | -| `ExcludedModels` | []`string` | ➖ | Remove these models from the router. Each entry is a model slug or a wildcard pattern (e.g. "xiaomi/*"). A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after `models`, so an excluded pattern always wins over an included one; when the lists leave no model the request can use, it fails with 404 rather than routing outside them. | [
"openai/gpt-6-astra",
"xiaomi/*"
] | -| `ID` | [components.JevRouterPluginID](../../models/components/jevrouterpluginid.mdx) | ✅ | N/A | | -| `Models` | []`string` | ➖ | Restrict the router to these models. Each entry is a model slug or a wildcard pattern (e.g. "anthropic/*"), matched against the current pool; models outside the pool are ignored. A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When omitted or empty, every model in the pool is a candidate; when no pool model matches, the list is ignored and the whole pool is used (`excluded_models` still apply). `allowed_models` is an alias; entries from both fields are combined. | [
"anthropic/*",
"openai/gpt-5.6-sol"
] | \ No newline at end of file +| `AllowedModels` | []`string` | :heavy_minus_sign: | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | +| `CostTier` | `*string` | :heavy_minus_sign: | Select low, medium, high, or a cost tier configured by the operator. Overrides the live-config tier and replaces the shared routing policy with that tier. Omit to use the live configuration. Model exclusions and the router kill switch still apply. | medium | +| `ExcludedModels` | []`string` | :heavy_minus_sign: | Remove these models from the router. Each entry is a model slug or a wildcard pattern (e.g. "xiaomi/*"). A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after `models`, so an excluded pattern always wins over an included one; when the lists leave no model the request can use, it fails with 404 rather than routing outside them. | [
"openai/gpt-6-astra",
"xiaomi/*"
] | +| `ID` | [components.JevRouterPluginID](../../models/components/jevrouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `Models` | []`string` | :heavy_minus_sign: | Restrict the router to these models. Each entry is a model slug or a wildcard pattern (e.g. "anthropic/*"), matched against the current pool; models outside the pool are ignored. A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When omitted or empty, every model in the pool is a candidate; when no pool model matches, the list is ignored and the whole pool is used (`excluded_models` still apply). `allowed_models` is an alias; entries from both fields are combined. | [
"anthropic/*",
"openai/gpt-5.6-sol"
] | \ No newline at end of file diff --git a/docs/models/components/keepall.mdx b/docs/models/components/keepall.mdx index cfd2cada7..ae5186c84 100644 --- a/docs/models/components/keepall.mdx +++ b/docs/models/components/keepall.mdx @@ -6,4 +6,4 @@ title: "KeepAll" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Type` | [components.KeepType](../../models/components/keeptype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.KeepType](../../models/components/keeptype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/key.mdx b/docs/models/components/key.mdx index 17f64d5ab..30db612e1 100644 --- a/docs/models/components/key.mdx +++ b/docs/models/components/key.mdx @@ -6,10 +6,10 @@ title: "Key" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `Alg` | [components.Alg](../../models/components/alg.mdx) | ✅ | N/A | -| `Crv` | [components.Crv](../../models/components/crv.mdx) | ✅ | N/A | -| `Kid` | `string` | ✅ | N/A | -| `Kty` | [components.Kty](../../models/components/kty.mdx) | ✅ | N/A | -| `Use` | [components.Use](../../models/components/use.mdx) | ✅ | N/A | -| `X` | `string` | ✅ | N/A | -| `Y` | `string` | ✅ | N/A | \ No newline at end of file +| `Alg` | [components.Alg](../../models/components/alg.mdx) | :heavy_check_mark: | N/A | +| `Crv` | [components.Crv](../../models/components/crv.mdx) | :heavy_check_mark: | N/A | +| `Kid` | `string` | :heavy_check_mark: | N/A | +| `Kty` | [components.Kty](../../models/components/kty.mdx) | :heavy_check_mark: | N/A | +| `Use` | [components.Use](../../models/components/use.mdx) | :heavy_check_mark: | N/A | +| `X` | `string` | :heavy_check_mark: | N/A | +| `Y` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/keyassignment.mdx b/docs/models/components/keyassignment.mdx index 53549ef05..2c43bdd78 100644 --- a/docs/models/components/keyassignment.mdx +++ b/docs/models/components/keyassignment.mdx @@ -6,10 +6,10 @@ title: "KeyAssignment" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `AssignedBy` | `*string` | ✅ | User ID of who made the assignment | user_abc123 | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `GuardrailID` | `string` | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `ID` | `string` | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `KeyHash` | `string` | ✅ | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `KeyLabel` | `string` | ✅ | Label of the API key | prod-key | -| `KeyName` | `string` | ✅ | Name of the API key | Production Key | \ No newline at end of file +| `AssignedBy` | `*string` | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `GuardrailID` | `string` | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `KeyHash` | `string` | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | +| `KeyLabel` | `string` | :heavy_check_mark: | Label of the API key | prod-key | +| `KeyName` | `string` | :heavy_check_mark: | Name of the API key | Production Key | \ No newline at end of file diff --git a/docs/models/components/legacychatcontentvideo.mdx b/docs/models/components/legacychatcontentvideo.mdx index b86f41be0..424b46635 100644 --- a/docs/models/components/legacychatcontentvideo.mdx +++ b/docs/models/components/legacychatcontentvideo.mdx @@ -4,12 +4,12 @@ title: "~~LegacyChatContentVideo~~" Video input content part (legacy format - deprecated) -> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Fields | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Type` | [components.LegacyChatContentVideoType](../../models/components/legacychatcontentvideotype.mdx) | ✅ | N/A | | -| `VideoURL` | [components.LegacyChatContentVideoInput](../../models/components/legacychatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `Type` | [components.LegacyChatContentVideoType](../../models/components/legacychatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | +| `VideoURL` | [components.LegacyChatContentVideoInput](../../models/components/legacychatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/components/legacychatcontentvideoinput.mdx b/docs/models/components/legacychatcontentvideoinput.mdx index 30ee33d08..89b253bb0 100644 --- a/docs/models/components/legacychatcontentvideoinput.mdx +++ b/docs/models/components/legacychatcontentvideoinput.mdx @@ -9,5 +9,5 @@ Video input object | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Processing` | [*components.LegacyChatContentVideoInputProcessing](../../models/components/legacychatcontentvideoinputprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `URL` | `string` | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file +| `Processing` | [*components.LegacyChatContentVideoInputProcessing](../../models/components/legacychatcontentvideoinputprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `URL` | `string` | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/models/components/legacywebsearchservertool.mdx b/docs/models/components/legacywebsearchservertool.mdx index dd619fb53..2550a3111 100644 --- a/docs/models/components/legacywebsearchservertool.mdx +++ b/docs/models/components/legacywebsearchservertool.mdx @@ -9,12 +9,12 @@ Web search tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | -| `Type` | [components.LegacyWebSearchServerToolType](../../models/components/legacywebsearchservertooltype.mdx) | ✅ | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `Type` | [components.LegacyWebSearchServerToolType](../../models/components/legacywebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/listbyokkeysresponse.mdx b/docs/models/components/listbyokkeysresponse.mdx index a42c2d555..78aefe26f 100644 --- a/docs/models/components/listbyokkeysresponse.mdx +++ b/docs/models/components/listbyokkeysresponse.mdx @@ -6,5 +6,5 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Data` | [][components.BYOKKey](../../models/components/byokkey.mdx) | ✅ | List of BYOK credentials. | | -| `TotalCount` | `int64` | ✅ | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file +| `Data` | [][components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | List of BYOK credentials. | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/components/listendpointsresponse.mdx b/docs/models/components/listendpointsresponse.mdx index a1301eb32..795ee2f8f 100644 --- a/docs/models/components/listendpointsresponse.mdx +++ b/docs/models/components/listendpointsresponse.mdx @@ -9,9 +9,9 @@ List of available endpoints for a model | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Architecture` | [components.Architecture](../../models/components/architecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `Created` | `int64` | ✅ | Unix timestamp of when the model was created | 1692901234 | -| `Description` | `string` | ✅ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `Endpoints` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | ✅ | List of available endpoints for this model | | -| `ID` | `string` | ✅ | Unique identifier for the model | openai/gpt-4 | -| `Name` | `string` | ✅ | Display name of the model | GPT-4 | \ No newline at end of file +| `Architecture` | [components.Architecture](../../models/components/architecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | +| `Description` | `string` | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `Endpoints` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | :heavy_check_mark: | List of available endpoints for this model | | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | +| `Name` | `string` | :heavy_check_mark: | Display name of the model | GPT-4 | \ No newline at end of file diff --git a/docs/models/components/listendusersresponse.mdx b/docs/models/components/listendusersresponse.mdx index fe5438327..9d843e5ae 100644 --- a/docs/models/components/listendusersresponse.mdx +++ b/docs/models/components/listendusersresponse.mdx @@ -6,5 +6,5 @@ title: "ListEndUsersResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Data` | [][components.EndUser](../../models/components/enduser.mdx) | ✅ | N/A | | -| `TotalCount` | `int64` | ✅ | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file +| `Data` | [][components.EndUser](../../models/components/enduser.mdx) | :heavy_check_mark: | N/A | | +| `TotalCount` | `int64` | :heavy_check_mark: | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file diff --git a/docs/models/components/listguardrailsresponse.mdx b/docs/models/components/listguardrailsresponse.mdx index 3a58d9243..f8330d492 100644 --- a/docs/models/components/listguardrailsresponse.mdx +++ b/docs/models/components/listguardrailsresponse.mdx @@ -6,5 +6,5 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.Guardrail](../../models/components/guardrail.mdx) | ✅ | List of guardrails | | -| `TotalCount` | `int64` | ✅ | Total number of guardrails | 25 | \ No newline at end of file +| `Data` | [][components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | List of guardrails | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file diff --git a/docs/models/components/listkeyassignmentsresponse.mdx b/docs/models/components/listkeyassignmentsresponse.mdx index a87334632..50b790255 100644 --- a/docs/models/components/listkeyassignmentsresponse.mdx +++ b/docs/models/components/listkeyassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Data` | [][components.KeyAssignment](../../models/components/keyassignment.mdx) | ✅ | List of key assignments | | -| `TotalCount` | `int64` | ✅ | Total number of key assignments for this guardrail | 25 | \ No newline at end of file +| `Data` | [][components.KeyAssignment](../../models/components/keyassignment.mdx) | :heavy_check_mark: | List of key assignments | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/docs/models/components/listmemberassignmentsresponse.mdx b/docs/models/components/listmemberassignmentsresponse.mdx index 7d426f679..47f80b073 100644 --- a/docs/models/components/listmemberassignmentsresponse.mdx +++ b/docs/models/components/listmemberassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Data` | [][components.MemberAssignment](../../models/components/memberassignment.mdx) | ✅ | List of member assignments | | -| `TotalCount` | `int64` | ✅ | Total number of member assignments | 10 | \ No newline at end of file +| `Data` | [][components.MemberAssignment](../../models/components/memberassignment.mdx) | :heavy_check_mark: | List of member assignments | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/docs/models/components/listobservabilitydestinationsresponse.mdx b/docs/models/components/listobservabilitydestinationsresponse.mdx index 29da8a3b4..0271143fe 100644 --- a/docs/models/components/listobservabilitydestinationsresponse.mdx +++ b/docs/models/components/listobservabilitydestinationsresponse.mdx @@ -6,5 +6,5 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Data` | [][components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | ✅ | List of observability destinations. | | -| `TotalCount` | `int64` | ✅ | Total number of destinations matching the filters. | 1 | \ No newline at end of file +| `Data` | [][components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | List of observability destinations. | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of destinations matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/components/listpresetsresponse.mdx b/docs/models/components/listpresetsresponse.mdx index eb5391e59..1b67ede4d 100644 --- a/docs/models/components/listpresetsresponse.mdx +++ b/docs/models/components/listpresetsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of presets. | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Data` | [][components.Preset](../../models/components/preset.mdx) | ✅ | N/A | -| `TotalCount` | `int64` | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.Preset](../../models/components/preset.mdx) | :heavy_check_mark: | N/A | +| `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/listpresetversionsresponse.mdx b/docs/models/components/listpresetversionsresponse.mdx index 93e14a0e6..625b2bbd6 100644 --- a/docs/models/components/listpresetversionsresponse.mdx +++ b/docs/models/components/listpresetversionsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of preset versions. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Data` | [][*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | ✅ | N/A | -| `TotalCount` | `int64` | ✅ | N/A | \ No newline at end of file +| `Data` | [][*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | :heavy_check_mark: | N/A | +| `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/listprivateendpointsresponse.mdx b/docs/models/components/listprivateendpointsresponse.mdx index 41e3794fd..618511e93 100644 --- a/docs/models/components/listprivateendpointsresponse.mdx +++ b/docs/models/components/listprivateendpointsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPrivateEndpointsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Data` | [][components.PrivateEndpointSummary](../../models/components/privateendpointsummary.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.PrivateEndpointSummary](../../models/components/privateendpointsummary.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/listscimgroupmappingsresponse.mdx b/docs/models/components/listscimgroupmappingsresponse.mdx index 0d981f84d..5c722d196 100644 --- a/docs/models/components/listscimgroupmappingsresponse.mdx +++ b/docs/models/components/listscimgroupmappingsresponse.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupMappingsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Data` | [][components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | ✅ | N/A | -| `TotalCount` | `int64` | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | +| `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/listscimgroupsresponse.mdx b/docs/models/components/listscimgroupsresponse.mdx index f7954a0f7..003a65257 100644 --- a/docs/models/components/listscimgroupsresponse.mdx +++ b/docs/models/components/listscimgroupsresponse.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupsResponse" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.ScimGroup](../../models/components/scimgroup.mdx) | ✅ | N/A | -| `TotalCount` | `int64` | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.ScimGroup](../../models/components/scimgroup.mdx) | :heavy_check_mark: | N/A | +| `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/listtoolsresponse.mdx b/docs/models/components/listtoolsresponse.mdx index f62cdff65..d420c9693 100644 --- a/docs/models/components/listtoolsresponse.mdx +++ b/docs/models/components/listtoolsresponse.mdx @@ -6,6 +6,6 @@ title: "ListToolsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [][components.ServerTool](../../models/components/servertool.mdx) | ✅ | N/A | | -| `Links` | [components.ListToolsResponseLinks](../../models/components/listtoolsresponselinks.mdx) | ✅ | N/A | | -| `TotalCount` | `int64` | ✅ | Total number of tools | 12 | \ No newline at end of file +| `Data` | [][components.ServerTool](../../models/components/servertool.mdx) | :heavy_check_mark: | N/A | | +| `Links` | [components.ListToolsResponseLinks](../../models/components/listtoolsresponselinks.mdx) | :heavy_check_mark: | N/A | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of tools | 12 | \ No newline at end of file diff --git a/docs/models/components/listtoolsresponselinks.mdx b/docs/models/components/listtoolsresponselinks.mdx index 77e0f0827..20891cf29 100644 --- a/docs/models/components/listtoolsresponselinks.mdx +++ b/docs/models/components/listtoolsresponselinks.mdx @@ -6,4 +6,4 @@ title: "ListToolsResponseLinks" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Next` | `*string` | ✅ | URL for the next page of results, or null if this is the last page | null | \ No newline at end of file +| `Next` | `*string` | :heavy_check_mark: | URL for the next page of results, or null if this is the last page | null | \ No newline at end of file diff --git a/docs/models/components/listworkspacebudgetsresponse.mdx b/docs/models/components/listworkspacebudgetsresponse.mdx index 93ae8c72b..b597bca5d 100644 --- a/docs/models/components/listworkspacebudgetsresponse.mdx +++ b/docs/models/components/listworkspacebudgetsresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceBudgetsResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | ✅ | List of budgets configured for the workspace | | -| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | false | \ No newline at end of file +| `Data` | [][components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | :heavy_check_mark: | List of budgets configured for the workspace | | +| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | false | \ No newline at end of file diff --git a/docs/models/components/listworkspacemembersresponse.mdx b/docs/models/components/listworkspacemembersresponse.mdx index e1422ed16..101bed62a 100644 --- a/docs/models/components/listworkspacemembersresponse.mdx +++ b/docs/models/components/listworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | ✅ | List of workspace members | | -| `TotalCount` | `int64` | ✅ | Total number of members in the workspace | 5 | \ No newline at end of file +| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | :heavy_check_mark: | List of workspace members | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of members in the workspace | 5 | \ No newline at end of file diff --git a/docs/models/components/listworkspacesresponse.mdx b/docs/models/components/listworkspacesresponse.mdx index a20e39412..8c5ee5bbc 100644 --- a/docs/models/components/listworkspacesresponse.mdx +++ b/docs/models/components/listworkspacesresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.Workspace](../../models/components/workspace.mdx) | ✅ | List of workspaces | | -| `TotalCount` | `int64` | ✅ | Total number of workspaces | 5 | \ No newline at end of file +| `Data` | [][components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | List of workspaces | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file diff --git a/docs/models/components/localshellcallitem.mdx b/docs/models/components/localshellcallitem.mdx index a33416e57..7f2394870 100644 --- a/docs/models/components/localshellcallitem.mdx +++ b/docs/models/components/localshellcallitem.mdx @@ -9,8 +9,8 @@ A local shell command execution call | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Action` | [components.LocalShellCallItemAction](../../models/components/localshellcallitemaction.mdx) | ✅ | N/A | | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.TypeLocalShellCall](../../models/components/typelocalshellcall.mdx) | ✅ | N/A | | \ No newline at end of file +| `Action` | [components.LocalShellCallItemAction](../../models/components/localshellcallitemaction.mdx) | :heavy_check_mark: | N/A | | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.TypeLocalShellCall](../../models/components/typelocalshellcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/localshellcallitemaction.mdx b/docs/models/components/localshellcallitemaction.mdx index 81e27326f..b78a3a789 100644 --- a/docs/models/components/localshellcallitemaction.mdx +++ b/docs/models/components/localshellcallitemaction.mdx @@ -6,9 +6,9 @@ title: "LocalShellCallItemAction" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Command` | []`string` | ✅ | N/A | -| `Env` | map[string]`string` | ✅ | N/A | -| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | -| `Type` | [components.TypeExec](../../models/components/typeexec.mdx) | ✅ | N/A | -| `User` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `WorkingDirectory` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file +| `Command` | []`string` | :heavy_check_mark: | N/A | +| `Env` | map[string]`string` | :heavy_check_mark: | N/A | +| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | +| `Type` | [components.TypeExec](../../models/components/typeexec.mdx) | :heavy_check_mark: | N/A | +| `User` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `WorkingDirectory` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/localshellcalloutputitem.mdx b/docs/models/components/localshellcalloutputitem.mdx index 742c4e674..14d681671 100644 --- a/docs/models/components/localshellcalloutputitem.mdx +++ b/docs/models/components/localshellcalloutputitem.mdx @@ -9,7 +9,7 @@ Output from a local shell command execution | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | N/A | | -| `Output` | `string` | ✅ | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | -| `Type` | [components.LocalShellCallOutputItemType](../../models/components/localshellcalloutputitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Output` | `string` | :heavy_check_mark: | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.LocalShellCallOutputItemType](../../models/components/localshellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/logprob.mdx b/docs/models/components/logprob.mdx index f7f753d42..94c343768 100644 --- a/docs/models/components/logprob.mdx +++ b/docs/models/components/logprob.mdx @@ -6,7 +6,7 @@ title: "Logprob" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Bytes` | []`int64` | ✅ | N/A | -| `Logprob` | `float64` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | -| `TopLogprobs` | [][components.ResponseOutputTextTopLogprob](../../models/components/responseoutputtexttoplogprob.mdx) | ✅ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_check_mark: | N/A | +| `Logprob` | `float64` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | +| `TopLogprobs` | [][components.ResponseOutputTextTopLogprob](../../models/components/responseoutputtexttoplogprob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/logprobs.mdx b/docs/models/components/logprobs.mdx index d21a081c7..7469b0c6a 100644 --- a/docs/models/components/logprobs.mdx +++ b/docs/models/components/logprobs.mdx @@ -6,5 +6,5 @@ title: "Logprobs" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Content` | [][components.LogprobsContent](../../models/components/logprobscontent.mdx) | ✅ | N/A | -| `Refusal` | optionalnullable.OptionalNullable[[][components.Refusal](../../models/components/refusal.mdx)] | ➖ | N/A | \ No newline at end of file +| `Content` | [][components.LogprobsContent](../../models/components/logprobscontent.mdx) | :heavy_check_mark: | N/A | +| `Refusal` | optionalnullable.OptionalNullable[[][components.Refusal](../../models/components/refusal.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/logprobscontent.mdx b/docs/models/components/logprobscontent.mdx index 8d63b0efb..cd0be419d 100644 --- a/docs/models/components/logprobscontent.mdx +++ b/docs/models/components/logprobscontent.mdx @@ -6,7 +6,7 @@ title: "LogprobsContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | ✅ | N/A | -| `Logprob` | `float64` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | -| `TopLogprobs` | [][components.ContentTopLogprob](../../models/components/contenttoplogprob.mdx) | ✅ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_check_mark: | N/A | +| `Logprob` | `float64` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | +| `TopLogprobs` | [][components.ContentTopLogprob](../../models/components/contenttoplogprob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/managedprivateendpoint.mdx b/docs/models/components/managedprivateendpoint.mdx index 50614a7a8..e1e30d353 100644 --- a/docs/models/components/managedprivateendpoint.mdx +++ b/docs/models/components/managedprivateendpoint.mdx @@ -6,12 +6,12 @@ title: "ManagedPrivateEndpoint" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `ModelName` | `*string` | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `ModelPermaslug` | `string` | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `ModelSlug` | `*string` | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `ProviderName` | `string` | ✅ | Display name of the upstream provider. | Azure | -| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | -| `DeclaredRegion` | [*components.PrivateEndpointDeclaredRegion](../../models/components/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `DeclaredZdr` | `*bool` | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `ModelName` | `*string` | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `ModelSlug` | `*string` | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `ProviderName` | `string` | :heavy_check_mark: | Display name of the upstream provider. | Azure | +| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | +| `DeclaredRegion` | [*components.PrivateEndpointDeclaredRegion](../../models/components/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `DeclaredZdr` | `*bool` | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | \ No newline at end of file diff --git a/docs/models/components/managedprivateendpointresponse.mdx b/docs/models/components/managedprivateendpointresponse.mdx index 1c36f6a81..2fa5f843d 100644 --- a/docs/models/components/managedprivateendpointresponse.mdx +++ b/docs/models/components/managedprivateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "ManagedPrivateEndpointResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.ManagedPrivateEndpoint](../../models/components/managedprivateendpoint.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.ManagedPrivateEndpoint](../../models/components/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/maxprice.mdx b/docs/models/components/maxprice.mdx index 68e35cb0b..b1ed976cd 100644 --- a/docs/models/components/maxprice.mdx +++ b/docs/models/components/maxprice.mdx @@ -9,8 +9,8 @@ The object specifying the maximum price you want to pay for this request. USD pr | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Audio` | `*string` | ➖ | Maximum price in USD per audio unit | -| `Completion` | `*string` | ➖ | Maximum price in USD per million completion tokens | -| `Image` | `*string` | ➖ | Maximum price in USD per image | -| `Prompt` | `*string` | ➖ | Maximum price in USD per million prompt tokens | -| `Request` | `*string` | ➖ | Maximum price in USD per request | \ No newline at end of file +| `Audio` | `*string` | :heavy_minus_sign: | Maximum price in USD per audio unit | +| `Completion` | `*string` | :heavy_minus_sign: | Maximum price in USD per million completion tokens | +| `Image` | `*string` | :heavy_minus_sign: | Maximum price in USD per image | +| `Prompt` | `*string` | :heavy_minus_sign: | Maximum price in USD per million prompt tokens | +| `Request` | `*string` | :heavy_minus_sign: | Maximum price in USD per request | \ No newline at end of file diff --git a/docs/models/components/mcpapprovalrequestitem.mdx b/docs/models/components/mcpapprovalrequestitem.mdx index 0b7f873e4..2bdcd9a2c 100644 --- a/docs/models/components/mcpapprovalrequestitem.mdx +++ b/docs/models/components/mcpapprovalrequestitem.mdx @@ -9,8 +9,8 @@ Request for approval to execute an MCP tool | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | -| `ServerLabel` | `string` | ✅ | N/A | -| `Type` | [components.McpApprovalRequestItemType](../../models/components/mcpapprovalrequestitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | +| `ServerLabel` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.McpApprovalRequestItemType](../../models/components/mcpapprovalrequestitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpapprovalresponseitem.mdx b/docs/models/components/mcpapprovalresponseitem.mdx index 9abbe874a..a8ff8a03a 100644 --- a/docs/models/components/mcpapprovalresponseitem.mdx +++ b/docs/models/components/mcpapprovalresponseitem.mdx @@ -9,8 +9,8 @@ User response to an MCP tool approval request | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ApprovalRequestID` | `string` | ✅ | N/A | -| `Approve` | `bool` | ✅ | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Reason` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.McpApprovalResponseItemType](../../models/components/mcpapprovalresponseitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ApprovalRequestID` | `string` | :heavy_check_mark: | N/A | +| `Approve` | `bool` | :heavy_check_mark: | N/A | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Reason` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.McpApprovalResponseItemType](../../models/components/mcpapprovalresponseitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpcallitem.mdx b/docs/models/components/mcpcallitem.mdx index 35139073c..26e4b7414 100644 --- a/docs/models/components/mcpcallitem.mdx +++ b/docs/models/components/mcpcallitem.mdx @@ -9,10 +9,10 @@ An MCP tool call with its output or error | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | ✅ | N/A | | -| `Error` | optionalnullable.OptionalNullable[[components.McpToolCallError](../../models/components/mcptoolcallerror.mdx)] | ➖ | Error from an MCP tool call, either a plain message or a structured error | \{
"code": 503,
"message": "Service Unavailable",
"type": "http_error"
} | -| `ID` | `string` | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Output` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ServerLabel` | `string` | ✅ | N/A | | -| `Type` | [components.McpCallItemType](../../models/components/mcpcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | | +| `Error` | optionalnullable.OptionalNullable[[components.McpToolCallError](../../models/components/mcptoolcallerror.mdx)] | :heavy_minus_sign: | Error from an MCP tool call, either a plain message or a structured error | \{
"code": 503,
"message": "Service Unavailable",
"type": "http_error"
} | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Output` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ServerLabel` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.McpCallItemType](../../models/components/mcpcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/mcphttperror.mdx b/docs/models/components/mcphttperror.mdx index 40e695d87..d7106ac3a 100644 --- a/docs/models/components/mcphttperror.mdx +++ b/docs/models/components/mcphttperror.mdx @@ -9,6 +9,6 @@ The MCP server request failed at the HTTP layer | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Type` | [components.McpHTTPErrorType](../../models/components/mcphttperrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.McpHTTPErrorType](../../models/components/mcphttperrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcplisttoolsitem.mdx b/docs/models/components/mcplisttoolsitem.mdx index 3be02ba0f..3fc1b4f36 100644 --- a/docs/models/components/mcplisttoolsitem.mdx +++ b/docs/models/components/mcplisttoolsitem.mdx @@ -9,8 +9,8 @@ List of available MCP tools from a server | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Error` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ID` | `string` | ✅ | N/A | -| `ServerLabel` | `string` | ✅ | N/A | -| `Tools` | [][components.McpListToolsItemTool](../../models/components/mcplisttoolsitemtool.mdx) | ✅ | N/A | -| `Type` | [components.McpListToolsItemType](../../models/components/mcplisttoolsitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Error` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `ServerLabel` | `string` | :heavy_check_mark: | N/A | +| `Tools` | [][components.McpListToolsItemTool](../../models/components/mcplisttoolsitemtool.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.McpListToolsItemType](../../models/components/mcplisttoolsitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcplisttoolsitemtool.mdx b/docs/models/components/mcplisttoolsitemtool.mdx index 5e67faec6..4aa3e1ff5 100644 --- a/docs/models/components/mcplisttoolsitemtool.mdx +++ b/docs/models/components/mcplisttoolsitemtool.mdx @@ -6,7 +6,7 @@ title: "McpListToolsItemTool" | Field | Type | Required | Description | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Annotations` | `any` | ➖ | N/A | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `InputSchema` | map[string]`any` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | \ No newline at end of file +| `Annotations` | `any` | :heavy_minus_sign: | N/A | +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `InputSchema` | map[string]`any` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpprotocolerror.mdx b/docs/models/components/mcpprotocolerror.mdx index 31b359424..cdcd6dfac 100644 --- a/docs/models/components/mcpprotocolerror.mdx +++ b/docs/models/components/mcpprotocolerror.mdx @@ -9,6 +9,6 @@ The MCP server returned a protocol-level error | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Type` | [components.McpProtocolErrorType](../../models/components/mcpprotocolerrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.McpProtocolErrorType](../../models/components/mcpprotocolerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpservertool.mdx b/docs/models/components/mcpservertool.mdx index 9dc3bfdc9..087a6cc0e 100644 --- a/docs/models/components/mcpservertool.mdx +++ b/docs/models/components/mcpservertool.mdx @@ -9,12 +9,12 @@ MCP (Model Context Protocol) tool configuration | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `AllowedTools` | optionalnullable.OptionalNullable[[components.AllowedToolsUnion](../../models/components/allowedtoolsunion.mdx)] | ➖ | N/A | -| `Authorization` | `*string` | ➖ | N/A | -| `ConnectorID` | [*components.ConnectorID](../../models/components/connectorid.mdx) | ➖ | N/A | -| `Headers` | optionalnullable.OptionalNullable[map[string]`string`] | ➖ | N/A | -| `RequireApproval` | optionalnullable.OptionalNullable[[components.RequireApprovalUnion](../../models/components/requireapprovalunion.mdx)] | ➖ | N/A | -| `ServerDescription` | `*string` | ➖ | N/A | -| `ServerLabel` | `string` | ✅ | N/A | -| `ServerURL` | `*string` | ➖ | N/A | -| `Type` | [components.McpServerToolType](../../models/components/mcpservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `AllowedTools` | optionalnullable.OptionalNullable[[components.AllowedToolsUnion](../../models/components/allowedtoolsunion.mdx)] | :heavy_minus_sign: | N/A | +| `Authorization` | `*string` | :heavy_minus_sign: | N/A | +| `ConnectorID` | [*components.ConnectorID](../../models/components/connectorid.mdx) | :heavy_minus_sign: | N/A | +| `Headers` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | N/A | +| `RequireApproval` | optionalnullable.OptionalNullable[[components.RequireApprovalUnion](../../models/components/requireapprovalunion.mdx)] | :heavy_minus_sign: | N/A | +| `ServerDescription` | `*string` | :heavy_minus_sign: | N/A | +| `ServerLabel` | `string` | :heavy_check_mark: | N/A | +| `ServerURL` | `*string` | :heavy_minus_sign: | N/A | +| `Type` | [components.McpServerToolType](../../models/components/mcpservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcptoolexecutionerror.mdx b/docs/models/components/mcptoolexecutionerror.mdx index db331a5ba..5998fcb01 100644 --- a/docs/models/components/mcptoolexecutionerror.mdx +++ b/docs/models/components/mcptoolexecutionerror.mdx @@ -9,5 +9,5 @@ The MCP tool ran but reported a failure | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Content` | `any` | ➖ | N/A | -| `Type` | [components.McpToolExecutionErrorType](../../models/components/mcptoolexecutionerrortype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | `any` | :heavy_minus_sign: | N/A | +| `Type` | [components.McpToolExecutionErrorType](../../models/components/mcptoolexecutionerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/memberassignment.mdx b/docs/models/components/memberassignment.mdx index dac9653a4..baaa31fbb 100644 --- a/docs/models/components/memberassignment.mdx +++ b/docs/models/components/memberassignment.mdx @@ -6,9 +6,9 @@ title: "MemberAssignment" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `AssignedBy` | `*string` | ✅ | User ID of who made the assignment | user_abc123 | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `GuardrailID` | `string` | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `ID` | `string` | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `OrganizationID` | `string` | ✅ | Organization ID | org_xyz789 | -| `UserID` | `string` | ✅ | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file +| `AssignedBy` | `*string` | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `GuardrailID` | `string` | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `OrganizationID` | `string` | :heavy_check_mark: | Organization ID | org_xyz789 | +| `UserID` | `string` | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file diff --git a/docs/models/components/message.mdx b/docs/models/components/message.mdx index 0dabd27de..9d8b0db8f 100644 --- a/docs/models/components/message.mdx +++ b/docs/models/components/message.mdx @@ -6,11 +6,11 @@ title: "Message" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Annotations` | [][components.Annotation](../../models/components/annotation.mdx) | ➖ | N/A | -| `Content` | `*string` | ✅ | N/A | -| `Images` | optionalnullable.OptionalNullable[[][components.Image](../../models/components/image.mdx)] | ➖ | N/A | -| `Reasoning` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ReasoningDetails` | optionalnullable.OptionalNullable[[][*components.ReasoningDetail](../../models/components/reasoningdetail.mdx)] | ➖ | N/A | -| `Refusal` | `*string` | ✅ | N/A | -| `Role` | [components.ChoiceRole](../../models/components/choicerole.mdx) | ✅ | N/A | -| `ToolCalls` | [][components.ToolCall](../../models/components/toolcall.mdx) | ➖ | N/A | \ No newline at end of file +| `Annotations` | [][components.Annotation](../../models/components/annotation.mdx) | :heavy_minus_sign: | N/A | +| `Content` | `*string` | :heavy_check_mark: | N/A | +| `Images` | optionalnullable.OptionalNullable[[][components.Image](../../models/components/image.mdx)] | :heavy_minus_sign: | N/A | +| `Reasoning` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ReasoningDetails` | optionalnullable.OptionalNullable[[][*components.ReasoningDetail](../../models/components/reasoningdetail.mdx)] | :heavy_minus_sign: | N/A | +| `Refusal` | `*string` | :heavy_check_mark: | N/A | +| `Role` | [components.ChoiceRole](../../models/components/choicerole.mdx) | :heavy_check_mark: | N/A | +| `ToolCalls` | [][components.ToolCall](../../models/components/toolcall.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesadvisortoolresultblock.mdx b/docs/models/components/messagesadvisortoolresultblock.mdx index 543f4980e..bf05787b4 100644 --- a/docs/models/components/messagesadvisortoolresultblock.mdx +++ b/docs/models/components/messagesadvisortoolresultblock.mdx @@ -9,6 +9,6 @@ Advisor tool result from a prior assistant turn, replayed back to the model on t | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Content` | map[string]`any` | ✅ | N/A | -| `ToolUseID` | `string` | ✅ | N/A | -| `Type` | [components.MessagesAdvisorToolResultBlockType](../../models/components/messagesadvisortoolresultblocktype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | map[string]`any` | :heavy_check_mark: | N/A | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesAdvisorToolResultBlockType](../../models/components/messagesadvisortoolresultblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesbashtoolresultblock.mdx b/docs/models/components/messagesbashtoolresultblock.mdx index f904b759c..d2e51ec9a 100644 --- a/docs/models/components/messagesbashtoolresultblock.mdx +++ b/docs/models/components/messagesbashtoolresultblock.mdx @@ -9,8 +9,8 @@ Output of a sandbox-executed `openrouter:bash` call from a prior assistant turn. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `Content` | map[string]`any` | ✅ | N/A | -| `Files` | [][components.MessagesBashToolResultBlockFile](../../models/components/messagesbashtoolresultblockfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `ToolUseID` | `string` | ✅ | N/A | -| `Type` | [components.MessagesBashToolResultBlockTypeOpenrouterBashToolResult](../../models/components/messagesbashtoolresultblocktypeopenrouterbashtoolresult.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `Content` | map[string]`any` | :heavy_check_mark: | N/A | +| `Files` | [][components.MessagesBashToolResultBlockFile](../../models/components/messagesbashtoolresultblockfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesBashToolResultBlockTypeOpenrouterBashToolResult](../../models/components/messagesbashtoolresultblocktypeopenrouterbashtoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesbashtoolresultblockfile.mdx b/docs/models/components/messagesbashtoolresultblockfile.mdx index 54ffdc525..48cad59a2 100644 --- a/docs/models/components/messagesbashtoolresultblockfile.mdx +++ b/docs/models/components/messagesbashtoolresultblockfile.mdx @@ -6,9 +6,9 @@ title: "MessagesBashToolResultBlockFile" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Type` | [components.MessagesBashToolResultBlockTypeContainerFileCitation](../../models/components/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesBashToolResultBlockTypeContainerFileCitation](../../models/components/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesfallbackparam.mdx b/docs/models/components/messagesfallbackparam.mdx index 5329ffcb5..18c5a3182 100644 --- a/docs/models/components/messagesfallbackparam.mdx +++ b/docs/models/components/messagesfallbackparam.mdx @@ -9,5 +9,5 @@ Fallback model to try when the primary model fails or refuses. Only the `model` | Field | Type | Required | Description | Example | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `Model` | `string` | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file diff --git a/docs/models/components/messagesmessageparam.mdx b/docs/models/components/messagesmessageparam.mdx index 31877ac94..174dbf1ac 100644 --- a/docs/models/components/messagesmessageparam.mdx +++ b/docs/models/components/messagesmessageparam.mdx @@ -9,7 +9,7 @@ Anthropic message with OpenRouter extensions | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| `ClearAt` | optionalnullable.OptionalNullable[[components.AnthropicSystemClearAt](../../models/components/anthropicsystemclearat.mdx)] | ➖ | N/A | next_user_message | -| `Content` | [components.MessagesMessageParamContentUnion5](../../models/components/messagesmessageparamcontentunion5.mdx) | ✅ | N/A | | -| `OutputConfig` | optionalnullable.OptionalNullable[[components.AnthropicMessageOutputConfig](../../models/components/anthropicmessageoutputconfig.mdx)] | ➖ | N/A | \{
"effort": "low"
} | -| `Role` | [components.MessagesMessageParamRole](../../models/components/messagesmessageparamrole.mdx) | ✅ | N/A | | \ No newline at end of file +| `ClearAt` | optionalnullable.OptionalNullable[[components.AnthropicSystemClearAt](../../models/components/anthropicsystemclearat.mdx)] | :heavy_minus_sign: | N/A | next_user_message | +| `Content` | [components.MessagesMessageParamContentUnion5](../../models/components/messagesmessageparamcontentunion5.mdx) | :heavy_check_mark: | N/A | | +| `OutputConfig` | optionalnullable.OptionalNullable[[components.AnthropicMessageOutputConfig](../../models/components/anthropicmessageoutputconfig.mdx)] | :heavy_minus_sign: | N/A | \{
"effort": "low"
} | +| `Role` | [components.MessagesMessageParamRole](../../models/components/messagesmessageparamrole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagesoutputconfig.mdx b/docs/models/components/messagesoutputconfig.mdx index a142cf935..5ec8f99fc 100644 --- a/docs/models/components/messagesoutputconfig.mdx +++ b/docs/models/components/messagesoutputconfig.mdx @@ -9,6 +9,6 @@ Configuration for controlling output behavior. Supports the effort parameter and | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigEffort](../../models/components/messagesoutputconfigeffort.mdx)] | ➖ | How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. | medium | -| `Format` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigFormat](../../models/components/messagesoutputconfigformat.mdx)] | ➖ | A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). | | -| `TaskBudget` | optionalnullable.OptionalNullable[[components.TaskBudget](../../models/components/taskbudget.mdx)] | ➖ | Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap. | \{
"total": 400000,
"type": "tokens"
} | \ No newline at end of file +| `Effort` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigEffort](../../models/components/messagesoutputconfigeffort.mdx)] | :heavy_minus_sign: | How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. | medium | +| `Format` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigFormat](../../models/components/messagesoutputconfigformat.mdx)] | :heavy_minus_sign: | A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). | | +| `TaskBudget` | optionalnullable.OptionalNullable[[components.TaskBudget](../../models/components/taskbudget.mdx)] | :heavy_minus_sign: | Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap. | \{
"total": 400000,
"type": "tokens"
} | \ No newline at end of file diff --git a/docs/models/components/messagesoutputconfigformat.mdx b/docs/models/components/messagesoutputconfigformat.mdx index e0a8ffd67..5454729a6 100644 --- a/docs/models/components/messagesoutputconfigformat.mdx +++ b/docs/models/components/messagesoutputconfigformat.mdx @@ -9,5 +9,5 @@ A schema to specify Claude's output format in responses. See [structured outputs | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Schema` | map[string]`any` | ✅ | N/A | -| `Type` | [components.MessagesOutputConfigTypeJSONSchema](../../models/components/messagesoutputconfigtypejsonschema.mdx) | ✅ | N/A | \ No newline at end of file +| `Schema` | map[string]`any` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesOutputConfigTypeJSONSchema](../../models/components/messagesoutputconfigtypejsonschema.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesrequest.mdx b/docs/models/components/messagesrequest.mdx index f6254287b..8f21c3027 100644 --- a/docs/models/components/messagesrequest.mdx +++ b/docs/models/components/messagesrequest.mdx @@ -9,30 +9,30 @@ Request schema for Anthropic Messages API endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `ContextManagement` | optionalnullable.OptionalNullable[[components.ContextManagement](../../models/components/contextmanagement.mdx)] | ➖ | N/A | | -| `Fallbacks` | optionalnullable.OptionalNullable[[][components.MessagesFallbackParam](../../models/components/messagesfallbackparam.mdx)] | ➖ | Fallback models to try if the primary model fails or refuses, in order. Handled by OpenRouter multi-model routing rather than Anthropic server-side fallbacks; cannot be combined with `models`. Each entry accepts only `model`. Maximum of 3 entries. | [
\{
"model": "claude-opus-4-8"
}
] | -| `MaxTokens` | `*int64` | ➖ | N/A | | -| `Messages` | [][components.MessagesMessageParam](../../models/components/messagesmessageparam.mdx) | ✅ | N/A | | -| `Metadata` | [*components.MessagesRequestMetadata](../../models/components/messagesrequestmetadata.mdx) | ➖ | N/A | | -| `Model` | `string` | ✅ | N/A | | -| `Models` | []`string` | ➖ | N/A | | -| `OutputConfig` | [*components.MessagesOutputConfig](../../models/components/messagesoutputconfig.mdx) | ➖ | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | -| `Plugins` | [][components.MessagesRequestPlugin](../../models/components/messagesrequestplugin.mdx) | ➖ | Plugins you want to enable for this request, including their settings. | | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `Safeguards` | optionalnullable.OptionalNullable[[][components.AnthropicSafeguard](../../models/components/anthropicsafeguard.mdx)] | ➖ | N/A | | -| `ServiceTier` | `*string` | ➖ | N/A | | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `Speed` | optionalnullable.OptionalNullable[[components.Speed](../../models/components/speed.mdx)] | ➖ | N/A | fast | -| `StopSequences` | []`string` | ➖ | N/A | | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `Stream` | `*bool` | ➖ | N/A | | -| `System` | [*components.System](../../models/components/system.mdx) | ➖ | N/A | | -| `Temperature` | `*float64` | ➖ | N/A | | -| `Thinking` | [*components.Thinking](../../models/components/thinking.mdx) | ➖ | N/A | | -| `ToolChoice` | [*components.ToolChoice](../../models/components/toolchoice.mdx) | ➖ | N/A | | -| `Tools` | [][components.MessagesRequestToolUnion](../../models/components/messagesrequesttoolunion.mdx) | ➖ | N/A | | -| `TopK` | `*int64` | ➖ | N/A | | -| `TopP` | `*float64` | ➖ | N/A | | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | ➖ | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `ContextManagement` | optionalnullable.OptionalNullable[[components.ContextManagement](../../models/components/contextmanagement.mdx)] | :heavy_minus_sign: | N/A | | +| `Fallbacks` | optionalnullable.OptionalNullable[[][components.MessagesFallbackParam](../../models/components/messagesfallbackparam.mdx)] | :heavy_minus_sign: | Fallback models to try if the primary model fails or refuses, in order. Handled by OpenRouter multi-model routing rather than Anthropic server-side fallbacks; cannot be combined with `models`. Each entry accepts only `model`. Maximum of 3 entries. | [
\{
"model": "claude-opus-4-8"
}
] | +| `MaxTokens` | `*int64` | :heavy_minus_sign: | N/A | | +| `Messages` | [][components.MessagesMessageParam](../../models/components/messagesmessageparam.mdx) | :heavy_check_mark: | N/A | | +| `Metadata` | [*components.MessagesRequestMetadata](../../models/components/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `Models` | []`string` | :heavy_minus_sign: | N/A | | +| `OutputConfig` | [*components.MessagesOutputConfig](../../models/components/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `Plugins` | [][components.MessagesRequestPlugin](../../models/components/messagesrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `Safeguards` | optionalnullable.OptionalNullable[[][components.AnthropicSafeguard](../../models/components/anthropicsafeguard.mdx)] | :heavy_minus_sign: | N/A | | +| `ServiceTier` | `*string` | :heavy_minus_sign: | N/A | | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `Speed` | optionalnullable.OptionalNullable[[components.Speed](../../models/components/speed.mdx)] | :heavy_minus_sign: | N/A | fast | +| `StopSequences` | []`string` | :heavy_minus_sign: | N/A | | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `Stream` | `*bool` | :heavy_minus_sign: | N/A | | +| `System` | [*components.System](../../models/components/system.mdx) | :heavy_minus_sign: | N/A | | +| `Temperature` | `*float64` | :heavy_minus_sign: | N/A | | +| `Thinking` | [*components.Thinking](../../models/components/thinking.mdx) | :heavy_minus_sign: | N/A | | +| `ToolChoice` | [*components.ToolChoice](../../models/components/toolchoice.mdx) | :heavy_minus_sign: | N/A | | +| `Tools` | [][components.MessagesRequestToolUnion](../../models/components/messagesrequesttoolunion.mdx) | :heavy_minus_sign: | N/A | | +| `TopK` | `*int64` | :heavy_minus_sign: | N/A | | +| `TopP` | `*float64` | :heavy_minus_sign: | N/A | | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file diff --git a/docs/models/components/messagesrequestmetadata.mdx b/docs/models/components/messagesrequestmetadata.mdx index 5b6105609..0464ea970 100644 --- a/docs/models/components/messagesrequestmetadata.mdx +++ b/docs/models/components/messagesrequestmetadata.mdx @@ -6,4 +6,4 @@ title: "MessagesRequestMetadata" | Field | Type | Required | Description | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `UserID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file +| `UserID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesrequesttool.mdx b/docs/models/components/messagesrequesttool.mdx index 8d1015aec..1d0f0d2a6 100644 --- a/docs/models/components/messagesrequesttool.mdx +++ b/docs/models/components/messagesrequesttool.mdx @@ -6,5 +6,5 @@ title: "MessagesRequestTool" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Type` | `string` | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagessearchmodelsservertool.mdx b/docs/models/components/messagessearchmodelsservertool.mdx index cdb17b982..24e11474a 100644 --- a/docs/models/components/messagessearchmodelsservertool.mdx +++ b/docs/models/components/messagessearchmodelsservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.MessagesSearchModelsServerToolType](../../models/components/messagessearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.MessagesSearchModelsServerToolType](../../models/components/messagessearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagesshelltoolresultblock.mdx b/docs/models/components/messagesshelltoolresultblock.mdx index 5cb77aec6..0633cae11 100644 --- a/docs/models/components/messagesshelltoolresultblock.mdx +++ b/docs/models/components/messagesshelltoolresultblock.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:shell` call from a prior assistant turn. Accepted on re | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `Content` | map[string]`any` | ✅ | N/A | -| `Files` | [][components.MessagesShellToolResultBlockFile](../../models/components/messagesshelltoolresultblockfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `ToolUseID` | `string` | ✅ | N/A | -| `Type` | [components.MessagesShellToolResultBlockTypeOpenrouterShellToolResult](../../models/components/messagesshelltoolresultblocktypeopenroutershelltoolresult.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `Content` | map[string]`any` | :heavy_check_mark: | N/A | +| `Files` | [][components.MessagesShellToolResultBlockFile](../../models/components/messagesshelltoolresultblockfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesShellToolResultBlockTypeOpenrouterShellToolResult](../../models/components/messagesshelltoolresultblocktypeopenroutershelltoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesshelltoolresultblockfile.mdx b/docs/models/components/messagesshelltoolresultblockfile.mdx index e3e0075c8..dd96a96c6 100644 --- a/docs/models/components/messagesshelltoolresultblockfile.mdx +++ b/docs/models/components/messagesshelltoolresultblockfile.mdx @@ -6,9 +6,9 @@ title: "MessagesShellToolResultBlockFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Type` | [components.MessagesShellToolResultBlockTypeContainerFileCitation](../../models/components/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesShellToolResultBlockTypeContainerFileCitation](../../models/components/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblock.mdx b/docs/models/components/messagestooladditionblock.mdx index e53057445..04bc32b20 100644 --- a/docs/models/components/messagestooladditionblock.mdx +++ b/docs/models/components/messagestooladditionblock.mdx @@ -9,6 +9,6 @@ Loads a previously deferred tool (declared in `tools` with `defer_loading: true` | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Tool` | [components.MessagesToolAdditionBlockToolUnion](../../models/components/messagestooladditionblocktoolunion.mdx) | ✅ | N/A | | -| `Type` | [components.TypeToolAddition](../../models/components/typetooladdition.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Tool` | [components.MessagesToolAdditionBlockToolUnion](../../models/components/messagestooladditionblocktoolunion.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeToolAddition](../../models/components/typetooladdition.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx b/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx index 46d3089e4..17210dc92 100644 --- a/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx +++ b/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx @@ -6,6 +6,6 @@ title: "MessagesToolAdditionBlockToolMcpToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `Name` | `string` | ✅ | N/A | -| `ServerName` | `string` | ✅ | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../../models/components/messagestooladditionblocktypemcptoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | N/A | +| `ServerName` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../../models/components/messagestooladditionblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx b/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx index c1065af26..f0b3ee7f5 100644 --- a/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx +++ b/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolAdditionBlockToolMcpToolsetReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `ServerName` | `string` | ✅ | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../../models/components/messagestooladditionblocktypemcptoolsetreference.mdx) | ✅ | N/A | \ No newline at end of file +| `ServerName` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../../models/components/messagestooladditionblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktooltoolreference.mdx b/docs/models/components/messagestooladditionblocktooltoolreference.mdx index 76c0a95c1..2c827a51b 100644 --- a/docs/models/components/messagestooladditionblocktooltoolreference.mdx +++ b/docs/models/components/messagestooladditionblocktooltoolreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolAdditionBlockToolToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `Name` | `string` | ✅ | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeToolReference](../../models/components/messagestooladditionblocktypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesToolAdditionBlockTypeToolReference](../../models/components/messagestooladditionblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblock.mdx b/docs/models/components/messagestoolremovalblock.mdx index a9b4d5145..c1e4f3ffd 100644 --- a/docs/models/components/messagestoolremovalblock.mdx +++ b/docs/models/components/messagestoolremovalblock.mdx @@ -9,6 +9,6 @@ Removes a tool from the conversation mid-conversation without invalidating the p | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Tool` | [components.MessagesToolRemovalBlockToolUnion](../../models/components/messagestoolremovalblocktoolunion.mdx) | ✅ | N/A | | -| `Type` | [components.TypeToolRemoval](../../models/components/typetoolremoval.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Tool` | [components.MessagesToolRemovalBlockToolUnion](../../models/components/messagestoolremovalblocktoolunion.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeToolRemoval](../../models/components/typetoolremoval.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx b/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx index bc0fefce0..5ec3917a4 100644 --- a/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx +++ b/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx @@ -6,6 +6,6 @@ title: "MessagesToolRemovalBlockToolMcpToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | ✅ | N/A | -| `ServerName` | `string` | ✅ | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../../models/components/messagestoolremovalblocktypemcptoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | N/A | +| `ServerName` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../../models/components/messagestoolremovalblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx b/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx index 158442cd7..f9f587ae1 100644 --- a/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx +++ b/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolRemovalBlockToolMcpToolsetReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `ServerName` | `string` | ✅ | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../../models/components/messagestoolremovalblocktypemcptoolsetreference.mdx) | ✅ | N/A | \ No newline at end of file +| `ServerName` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../../models/components/messagestoolremovalblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktooltoolreference.mdx b/docs/models/components/messagestoolremovalblocktooltoolreference.mdx index 105666952..c14482031 100644 --- a/docs/models/components/messagestoolremovalblocktooltoolreference.mdx +++ b/docs/models/components/messagestoolremovalblocktooltoolreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolRemovalBlockToolToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | ✅ | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeToolReference](../../models/components/messagestoolremovalblocktypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.MessagesToolRemovalBlockTypeToolReference](../../models/components/messagestoolremovalblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mismatchbehavior.mdx b/docs/models/components/mismatchbehavior.mdx index 231851846..a887dcca6 100644 --- a/docs/models/components/mismatchbehavior.mdx +++ b/docs/models/components/mismatchbehavior.mdx @@ -4,7 +4,7 @@ title: "~~MismatchBehavior~~" Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. -> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Example Usage diff --git a/docs/models/components/model.mdx b/docs/models/components/model.mdx index 1cfabfa1d..f8b1ee5c7 100644 --- a/docs/models/components/model.mdx +++ b/docs/models/components/model.mdx @@ -9,23 +9,23 @@ Information about an AI model available on OpenRouter | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AliasTarget` | [*components.ModelAliasTarget](../../models/components/modelaliastarget.mdx) | ➖ | Concrete model targeted by this tilde-latest alias, when applicable | \{
"name": "Claude Sonnet 4.5",
"slug": "anthropic/claude-sonnet-4.5"
} | -| `Architecture` | [components.ModelArchitecture](../../models/components/modelarchitecture.mdx) | ✅ | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `Benchmarks` | [*components.ModelBenchmarks](../../models/components/modelbenchmarks.mdx) | ➖ | Third-party benchmark rankings for this model. Omitted when no benchmark data is available. | \{
"artificial_analysis": \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
},
"design_arena": [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
]
} | -| `CanonicalSlug` | `string` | ✅ | Canonical slug for the model | openai/gpt-4 | -| `ContextLength` | `*int64` | ✅ | Maximum context length in tokens | 8192 | -| `Created` | `int64` | ✅ | Unix timestamp of when the model was created | 1692901234 | -| `DefaultParameters` | [*components.DefaultParameters](../../models/components/defaultparameters.mdx) | ✅ | Default parameters for this model | \{
"frequency_penalty": 0,
"presence_penalty": 0,
"repetition_penalty": 1,
"temperature": 0.7,
"top_k": 0,
"top_p": 0.9
} | -| `Description` | `*string` | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `ExpirationDate` | optionalnullable.OptionalNullable[`string`] | ➖ | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | -| `HuggingFaceID` | optionalnullable.OptionalNullable[`string`] | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `ID` | `string` | ✅ | Unique identifier for the model | openai/gpt-4 | -| `KnowledgeCutoff` | optionalnullable.OptionalNullable[`string`] | ➖ | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 | -| `Links` | [components.ModelLinks](../../models/components/modellinks.mdx) | ✅ | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | -| `Name` | `string` | ✅ | Display name of the model | GPT-4 | -| `PerRequestLimits` | [*components.PerRequestLimits](../../models/components/perrequestlimits.mdx) | ✅ | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | -| `Pricing` | [components.PublicPricing](../../models/components/publicpricing.mdx) | ✅ | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | -| `Reasoning` | [*components.ModelReasoning](../../models/components/modelreasoning.mdx) | ➖ | Reasoning effort configuration. Omitted for non-reasoning models and dynamic router models. | \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
} | -| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | ✅ | List of supported parameters for this model | | -| `SupportedVoices` | []`string` | ✅ | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | -| `TopProvider` | [components.TopProviderInfo](../../models/components/topproviderinfo.mdx) | ✅ | Information about the top provider for this model | \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
} | \ No newline at end of file +| `AliasTarget` | [*components.ModelAliasTarget](../../models/components/modelaliastarget.mdx) | :heavy_minus_sign: | Concrete model targeted by this tilde-latest alias, when applicable | \{
"name": "Claude Sonnet 4.5",
"slug": "anthropic/claude-sonnet-4.5"
} | +| `Architecture` | [components.ModelArchitecture](../../models/components/modelarchitecture.mdx) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `Benchmarks` | [*components.ModelBenchmarks](../../models/components/modelbenchmarks.mdx) | :heavy_minus_sign: | Third-party benchmark rankings for this model. Omitted when no benchmark data is available. | \{
"artificial_analysis": \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
},
"design_arena": [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
]
} | +| `CanonicalSlug` | `string` | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | +| `ContextLength` | `*int64` | :heavy_check_mark: | Maximum context length in tokens | 8192 | +| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | +| `DefaultParameters` | [*components.DefaultParameters](../../models/components/defaultparameters.mdx) | :heavy_check_mark: | Default parameters for this model | \{
"frequency_penalty": 0,
"presence_penalty": 0,
"repetition_penalty": 1,
"temperature": 0.7,
"top_k": 0,
"top_p": 0.9
} | +| `Description` | `*string` | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `ExpirationDate` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | +| `HuggingFaceID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | +| `KnowledgeCutoff` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 | +| `Links` | [components.ModelLinks](../../models/components/modellinks.mdx) | :heavy_check_mark: | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | +| `Name` | `string` | :heavy_check_mark: | Display name of the model | GPT-4 | +| `PerRequestLimits` | [*components.PerRequestLimits](../../models/components/perrequestlimits.mdx) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | +| `Pricing` | [components.PublicPricing](../../models/components/publicpricing.mdx) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | +| `Reasoning` | [*components.ModelReasoning](../../models/components/modelreasoning.mdx) | :heavy_minus_sign: | Reasoning effort configuration. Omitted for non-reasoning models and dynamic router models. | \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
} | +| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | :heavy_check_mark: | List of supported parameters for this model | | +| `SupportedVoices` | []`string` | :heavy_check_mark: | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | +| `TopProvider` | [components.TopProviderInfo](../../models/components/topproviderinfo.mdx) | :heavy_check_mark: | Information about the top provider for this model | \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
} | \ No newline at end of file diff --git a/docs/models/components/modelaliastarget.mdx b/docs/models/components/modelaliastarget.mdx index e53c88828..3a99ae71f 100644 --- a/docs/models/components/modelaliastarget.mdx +++ b/docs/models/components/modelaliastarget.mdx @@ -9,5 +9,5 @@ Concrete model targeted by this tilde-latest alias, when applicable | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Name` | `string` | ✅ | Human-readable name of the concrete model targeted by this alias | -| `Slug` | `string` | ✅ | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | Human-readable name of the concrete model targeted by this alias | +| `Slug` | `string` | :heavy_check_mark: | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file diff --git a/docs/models/components/modelarchitecture.mdx b/docs/models/components/modelarchitecture.mdx index 235cbf81e..0a41c1fcd 100644 --- a/docs/models/components/modelarchitecture.mdx +++ b/docs/models/components/modelarchitecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | ✅ | Supported input modalities | | -| `InstructType` | optionalnullable.OptionalNullable[[components.InstructType](../../models/components/instructtype.mdx)] | ➖ | Instruction format type | chatml | -| `Modality` | `*string` | ✅ | Primary modality of the model | text->text | -| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | ✅ | Supported output modalities | | -| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | ➖ | Tokenizer type used by the model | GPT | \ No newline at end of file +| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | :heavy_check_mark: | Supported input modalities | | +| `InstructType` | optionalnullable.OptionalNullable[[components.InstructType](../../models/components/instructtype.mdx)] | :heavy_minus_sign: | Instruction format type | chatml | +| `Modality` | `*string` | :heavy_check_mark: | Primary modality of the model | text->text | +| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | :heavy_check_mark: | Supported output modalities | | +| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/docs/models/components/modelbenchmarks.mdx b/docs/models/components/modelbenchmarks.mdx index f35bfc48c..d5cae8857 100644 --- a/docs/models/components/modelbenchmarks.mdx +++ b/docs/models/components/modelbenchmarks.mdx @@ -9,5 +9,5 @@ Third-party benchmark rankings for this model. Omitted when no benchmark data is | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ArtificialAnalysis` | [*components.AABenchmarkEntry](../../models/components/aabenchmarkentry.mdx) | ➖ | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | -| `DesignArena` | [][components.DABenchmarkEntry](../../models/components/dabenchmarkentry.mdx) | ✅ | Design Arena ELO rankings across arena+category pairs. | [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
] | \ No newline at end of file +| `ArtificialAnalysis` | [*components.AABenchmarkEntry](../../models/components/aabenchmarkentry.mdx) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | +| `DesignArena` | [][components.DABenchmarkEntry](../../models/components/dabenchmarkentry.mdx) | :heavy_check_mark: | Design Arena ELO rankings across arena+category pairs. | [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
] | \ No newline at end of file diff --git a/docs/models/components/modellinks.mdx b/docs/models/components/modellinks.mdx index 5c725e7b8..1273737d5 100644 --- a/docs/models/components/modellinks.mdx +++ b/docs/models/components/modellinks.mdx @@ -9,4 +9,4 @@ Related API endpoints and resources for this model. | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `Details` | `string` | ✅ | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file +| `Details` | `string` | :heavy_check_mark: | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file diff --git a/docs/models/components/modelreasoning.mdx b/docs/models/components/modelreasoning.mdx index a5b000f6d..4888367ce 100644 --- a/docs/models/components/modelreasoning.mdx +++ b/docs/models/components/modelreasoning.mdx @@ -9,8 +9,8 @@ Reasoning effort configuration. Omitted for non-reasoning models and dynamic rou | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `DefaultEffort` | optionalnullable.OptionalNullable[[components.DefaultEffort](../../models/components/defaulteffort.mdx)] | ➖ | N/A | medium | -| `DefaultEnabled` | `*bool` | ➖ | Default reasoning enabled state when the client does not set `reasoning.enabled`. | | -| `Mandatory` | `bool` | ✅ | When true, reasoning cannot be disabled and effort "none" is rejected. | | -| `SupportedEfforts` | optionalnullable.OptionalNullable[[][*components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | ➖ | Allowed reasoning effort values for this model, in descending effort order (highest first). Null means no allowlist — all gateway effort values are accepted. | | -| `SupportsMaxTokens` | `*bool` | ➖ | Present and `true` when the model accepts `reasoning.max_tokens` in requests (Anthropic-style) instead of or in addition to `reasoning.effort`. Omitted otherwise. | | \ No newline at end of file +| `DefaultEffort` | optionalnullable.OptionalNullable[[components.DefaultEffort](../../models/components/defaulteffort.mdx)] | :heavy_minus_sign: | N/A | medium | +| `DefaultEnabled` | `*bool` | :heavy_minus_sign: | Default reasoning enabled state when the client does not set `reasoning.enabled`. | | +| `Mandatory` | `bool` | :heavy_check_mark: | When true, reasoning cannot be disabled and effort "none" is rejected. | | +| `SupportedEfforts` | optionalnullable.OptionalNullable[[][*components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | :heavy_minus_sign: | Allowed reasoning effort values for this model, in descending effort order (highest first). Null means no allowlist — all gateway effort values are accepted. | | +| `SupportsMaxTokens` | `*bool` | :heavy_minus_sign: | Present and `true` when the model accepts `reasoning.max_tokens` in requests (Anthropic-style) instead of or in addition to `reasoning.effort`. Omitted otherwise. | | \ No newline at end of file diff --git a/docs/models/components/modelresponse.mdx b/docs/models/components/modelresponse.mdx index 91e2a4b91..ac70fdd90 100644 --- a/docs/models/components/modelresponse.mdx +++ b/docs/models/components/modelresponse.mdx @@ -9,4 +9,4 @@ Single model response | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Model](../../models/components/model.mdx) | ✅ | Information about an AI model available on OpenRouter | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"reasoning": \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
} | \ No newline at end of file +| `Data` | [components.Model](../../models/components/model.mdx) | :heavy_check_mark: | Information about an AI model available on OpenRouter | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"reasoning": \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
} | \ No newline at end of file diff --git a/docs/models/components/modelscountresponse.mdx b/docs/models/components/modelscountresponse.mdx index 4044230c8..04b817d9e 100644 --- a/docs/models/components/modelscountresponse.mdx +++ b/docs/models/components/modelscountresponse.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Data` | [components.ModelsCountResponseData](../../models/components/modelscountresponsedata.mdx) | ✅ | Model count data | \{
"count": 150
} | \ No newline at end of file +| `Data` | [components.ModelsCountResponseData](../../models/components/modelscountresponsedata.mdx) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file diff --git a/docs/models/components/modelscountresponsedata.mdx b/docs/models/components/modelscountresponsedata.mdx index 2ffd7a93e..42e60f32c 100644 --- a/docs/models/components/modelscountresponsedata.mdx +++ b/docs/models/components/modelscountresponsedata.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `Count` | `int64` | ✅ | Total number of available models | 150 | \ No newline at end of file +| `Count` | `int64` | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file diff --git a/docs/models/components/modelslistresponse.mdx b/docs/models/components/modelslistresponse.mdx index 10a74b63b..ef5d7e350 100644 --- a/docs/models/components/modelslistresponse.mdx +++ b/docs/models/components/modelslistresponse.mdx @@ -9,6 +9,6 @@ List of available models | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.Model](../../models/components/model.mdx) | ✅ | List of available models | [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
] | -| `Links` | [components.ModelsListResponseLinks](../../models/components/modelslistresponselinks.mdx) | ✅ | Pagination links | | -| `TotalCount` | `int64` | ✅ | Total number of models matching the query | 150 | \ No newline at end of file +| `Data` | [][components.Model](../../models/components/model.mdx) | :heavy_check_mark: | List of available models | [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
] | +| `Links` | [components.ModelsListResponseLinks](../../models/components/modelslistresponselinks.mdx) | :heavy_check_mark: | Pagination links | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of models matching the query | 150 | \ No newline at end of file diff --git a/docs/models/components/modelslistresponselinks.mdx b/docs/models/components/modelslistresponselinks.mdx index c366d0d34..3e5dbd139 100644 --- a/docs/models/components/modelslistresponselinks.mdx +++ b/docs/models/components/modelslistresponselinks.mdx @@ -9,4 +9,4 @@ Pagination links | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Next` | `*string` | ✅ | URL for the next page of results, or null if this is the last page | /api/v1/models?offset=500&limit=500 | \ No newline at end of file +| `Next` | `*string` | :heavy_check_mark: | URL for the next page of results, or null if this is the last page | /api/v1/models?offset=500&limit=500 | \ No newline at end of file diff --git a/docs/models/components/moderationplugin.mdx b/docs/models/components/moderationplugin.mdx index 48856fd8f..589e0cdd2 100644 --- a/docs/models/components/moderationplugin.mdx +++ b/docs/models/components/moderationplugin.mdx @@ -6,4 +6,4 @@ title: "ModerationPlugin" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ID` | [components.ModerationPluginID](../../models/components/moderationpluginid.mdx) | ✅ | N/A | \ No newline at end of file +| `ID` | [components.ModerationPluginID](../../models/components/moderationpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/multimodalmedia.mdx b/docs/models/components/multimodalmedia.mdx index dfc47ecb9..d1b0a4973 100644 --- a/docs/models/components/multimodalmedia.mdx +++ b/docs/models/components/multimodalmedia.mdx @@ -6,5 +6,5 @@ title: "MultimodalMedia" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Data` | `string` | ✅ | N/A | -| `Format` | `*string` | ➖ | N/A | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | N/A | +| `Format` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/namespacefunctiontool.mdx b/docs/models/components/namespacefunctiontool.mdx index 230ec6ce3..4c46f05a4 100644 --- a/docs/models/components/namespacefunctiontool.mdx +++ b/docs/models/components/namespacefunctiontool.mdx @@ -9,12 +9,12 @@ A function tool grouped inside a namespace tool | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedCallers` | optionalnullable.OptionalNullable[[][components.AllowedCaller](../../models/components/allowedcaller.mdx)] | ➖ | N/A | | -| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | ➖ | N/A | | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `OutputSchema` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | | -| `Parameters` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `Type` | [components.NamespaceFunctionToolType](../../models/components/namespacefunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `AllowedCallers` | optionalnullable.OptionalNullable[[][components.AllowedCaller](../../models/components/allowedcaller.mdx)] | :heavy_minus_sign: | N/A | | +| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `OutputSchema` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | | +| `Parameters` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.NamespaceFunctionToolType](../../models/components/namespacefunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/namespacetool.mdx b/docs/models/components/namespacetool.mdx index a371cb56d..63b20c09b 100644 --- a/docs/models/components/namespacetool.mdx +++ b/docs/models/components/namespacetool.mdx @@ -9,7 +9,7 @@ Groups function/custom tools under a shared namespace | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Description` | `string` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | -| `Tools` | [][components.NamespaceToolTool](../../models/components/namespacetooltool.mdx) | ✅ | N/A | -| `Type` | [components.NamespaceToolType](../../models/components/namespacetooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `Description` | `string` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | +| `Tools` | [][components.NamespaceToolTool](../../models/components/namespacetooltool.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.NamespaceToolType](../../models/components/namespacetooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/nativesupport.mdx b/docs/models/components/nativesupport.mdx index d69276ca6..712f26a7b 100644 --- a/docs/models/components/nativesupport.mdx +++ b/docs/models/components/nativesupport.mdx @@ -9,6 +9,6 @@ Endpoints whose provider runs this tool itself during inference. Zero for tools | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `EndpointCount` | `int64` | ✅ | N/A | 18 | -| `ModelCount` | `int64` | ✅ | N/A | 12 | -| `Models` | [][components.ServerToolNativeModel](../../models/components/servertoolnativemodel.mdx) | ✅ | N/A | | \ No newline at end of file +| `EndpointCount` | `int64` | :heavy_check_mark: | N/A | 18 | +| `ModelCount` | `int64` | :heavy_check_mark: | N/A | 12 | +| `Models` | [][components.ServerToolNativeModel](../../models/components/servertoolnativemodel.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/nativetools.mdx b/docs/models/components/nativetools.mdx index bfdf5a3a0..2e0483ed4 100644 --- a/docs/models/components/nativetools.mdx +++ b/docs/models/components/nativetools.mdx @@ -6,4 +6,4 @@ title: "NativeTools" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Type` | `string` | ✅ | The provider tool type the request is translated to when this tool runs natively, e.g. `web_search_20260209` on Anthropic or `google_search` on Gemini. | \ No newline at end of file +| `Type` | `string` | :heavy_check_mark: | The provider tool type the request is translated to when this tool runs natively, e.g. `web_search_20260209` on Anthropic or `google_search` on Gemini. | \ No newline at end of file diff --git a/docs/models/components/never.mdx b/docs/models/components/never.mdx index 6d40ecc31..0d6a9b031 100644 --- a/docs/models/components/never.mdx +++ b/docs/models/components/never.mdx @@ -6,4 +6,4 @@ title: "Never" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ToolNames` | []`string` | ➖ | N/A | \ No newline at end of file +| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/notfoundresponseerrordata.mdx b/docs/models/components/notfoundresponseerrordata.mdx index 6343f9182..f1786ff95 100644 --- a/docs/models/components/notfoundresponseerrordata.mdx +++ b/docs/models/components/notfoundresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for NotFoundResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/oauthjwks.mdx b/docs/models/components/oauthjwks.mdx index 3314dbc90..6f694de91 100644 --- a/docs/models/components/oauthjwks.mdx +++ b/docs/models/components/oauthjwks.mdx @@ -9,4 +9,4 @@ RFC 7517 JWK Set of the keys OpenRouter signs access tokens with. | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Keys` | [][components.Key](../../models/components/key.mdx) | ✅ | N/A | \ No newline at end of file +| `Keys` | [][components.Key](../../models/components/key.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityarizedestination.mdx b/docs/models/components/observabilityarizedestination.mdx index 8bfd85ed3..2b3ec3a69 100644 --- a/docs/models/components/observabilityarizedestination.mdx +++ b/docs/models/components/observabilityarizedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityArizeDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityArizeDestinationConfig](../../models/components/observabilityarizedestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityArizeDestinationType](../../models/components/observabilityarizedestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityArizeDestinationConfig](../../models/components/observabilityarizedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityArizeDestinationType](../../models/components/observabilityarizedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityarizedestinationconfig.mdx b/docs/models/components/observabilityarizedestinationconfig.mdx index 27a844955..63f7eb5fa 100644 --- a/docs/models/components/observabilityarizedestinationconfig.mdx +++ b/docs/models/components/observabilityarizedestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityArizeDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | ✅ | N/A | -| `BaseURL` | `*string` | ➖ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `ModelID` | `string` | ✅ | The name of the tracing project in Arize AX | -| `SpaceKey` | `string` | ✅ | N/A | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | N/A | +| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `ModelID` | `string` | :heavy_check_mark: | The name of the tracing project in Arize AX | +| `SpaceKey` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitybraintrustdestination.mdx b/docs/models/components/observabilitybraintrustdestination.mdx index 9a8d41c22..6ad5d1c7a 100644 --- a/docs/models/components/observabilitybraintrustdestination.mdx +++ b/docs/models/components/observabilitybraintrustdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityBraintrustDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityBraintrustDestinationConfig](../../models/components/observabilitybraintrustdestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityBraintrustDestinationType](../../models/components/observabilitybraintrustdestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityBraintrustDestinationConfig](../../models/components/observabilitybraintrustdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityBraintrustDestinationType](../../models/components/observabilitybraintrustdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitybraintrustdestinationconfig.mdx b/docs/models/components/observabilitybraintrustdestinationconfig.mdx index 827b1afc5..77e375f62 100644 --- a/docs/models/components/observabilitybraintrustdestinationconfig.mdx +++ b/docs/models/components/observabilitybraintrustdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityBraintrustDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | ✅ | N/A | -| `BaseURL` | `*string` | ➖ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `ProjectID` | `string` | ✅ | N/A | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | N/A | +| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `ProjectID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityclickhousedestination.mdx b/docs/models/components/observabilityclickhousedestination.mdx index d1e8a1790..b9d41f5db 100644 --- a/docs/models/components/observabilityclickhousedestination.mdx +++ b/docs/models/components/observabilityclickhousedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityClickhouseDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityClickhouseDestinationConfig](../../models/components/observabilityclickhousedestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityClickhouseDestinationType](../../models/components/observabilityclickhousedestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityClickhouseDestinationConfig](../../models/components/observabilityclickhousedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityClickhouseDestinationType](../../models/components/observabilityclickhousedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityclickhousedestinationconfig.mdx b/docs/models/components/observabilityclickhousedestinationconfig.mdx index c1410ec1f..db41a707c 100644 --- a/docs/models/components/observabilityclickhousedestinationconfig.mdx +++ b/docs/models/components/observabilityclickhousedestinationconfig.mdx @@ -6,10 +6,10 @@ title: "ObservabilityClickhouseDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Database` | `string` | ✅ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `Host` | `string` | ✅ | N/A | -| `Password` | `string` | ✅ | N/A | -| `ShouldIncludeCacheWriteTokens` | `*bool` | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `Table` | `*string` | ➖ | N/A | -| `Username` | `string` | ✅ | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file +| `Database` | `string` | :heavy_check_mark: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `Host` | `string` | :heavy_check_mark: | N/A | +| `Password` | `string` | :heavy_check_mark: | N/A | +| `ShouldIncludeCacheWriteTokens` | `*bool` | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `Table` | `*string` | :heavy_minus_sign: | N/A | +| `Username` | `string` | :heavy_check_mark: | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file diff --git a/docs/models/components/observabilitydatadogdestination.mdx b/docs/models/components/observabilitydatadogdestination.mdx index ce82ebe1d..504ff43ca 100644 --- a/docs/models/components/observabilitydatadogdestination.mdx +++ b/docs/models/components/observabilitydatadogdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityDatadogDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityDatadogDestinationConfig](../../models/components/observabilitydatadogdestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityDatadogDestinationType](../../models/components/observabilitydatadogdestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityDatadogDestinationConfig](../../models/components/observabilitydatadogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityDatadogDestinationType](../../models/components/observabilitydatadogdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitydatadogdestinationconfig.mdx b/docs/models/components/observabilitydatadogdestinationconfig.mdx index 1108f66ac..87aed2460 100644 --- a/docs/models/components/observabilitydatadogdestinationconfig.mdx +++ b/docs/models/components/observabilitydatadogdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityDatadogDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKey` | `string` | ✅ | Datadog API key must have LLM Observability permissions. Create at: | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `MlApp` | `string` | ✅ | Name to identify your application in Datadog LLM Observability | -| `URL` | `*string` | ➖ | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.us5.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | Datadog API key must have LLM Observability permissions. Create at: | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `MlApp` | `string` | :heavy_check_mark: | Name to identify your application in Datadog LLM Observability | +| `URL` | `*string` | :heavy_minus_sign: | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.us5.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file diff --git a/docs/models/components/observabilityfilterrulegroup.mdx b/docs/models/components/observabilityfilterrulegroup.mdx index 5e380e8bf..a9a091697 100644 --- a/docs/models/components/observabilityfilterrulegroup.mdx +++ b/docs/models/components/observabilityfilterrulegroup.mdx @@ -6,5 +6,5 @@ title: "ObservabilityFilterRuleGroup" | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Logic` | [*components.Logic](../../models/components/logic.mdx) | ➖ | N/A | -| `Rules` | [][components.Rule](../../models/components/rule.mdx) | ✅ | N/A | \ No newline at end of file +| `Logic` | [*components.Logic](../../models/components/logic.mdx) | :heavy_minus_sign: | N/A | +| `Rules` | [][components.Rule](../../models/components/rule.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityfilterrulesconfig.mdx b/docs/models/components/observabilityfilterrulesconfig.mdx index d3dc2764e..a7593a36d 100644 --- a/docs/models/components/observabilityfilterrulesconfig.mdx +++ b/docs/models/components/observabilityfilterrulesconfig.mdx @@ -9,5 +9,5 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | ➖ | N/A | -| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | ✅ | N/A | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | +| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityfilterrulesconfignullable.mdx b/docs/models/components/observabilityfilterrulesconfignullable.mdx index 7f1981f42..adfe79152 100644 --- a/docs/models/components/observabilityfilterrulesconfignullable.mdx +++ b/docs/models/components/observabilityfilterrulesconfignullable.mdx @@ -9,5 +9,5 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | ➖ | N/A | -| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | ✅ | N/A | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | +| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitygrafanadestination.mdx b/docs/models/components/observabilitygrafanadestination.mdx index a6c71072f..ba083b738 100644 --- a/docs/models/components/observabilitygrafanadestination.mdx +++ b/docs/models/components/observabilitygrafanadestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityGrafanaDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityGrafanaDestinationConfig](../../models/components/observabilitygrafanadestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityGrafanaDestinationType](../../models/components/observabilitygrafanadestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityGrafanaDestinationConfig](../../models/components/observabilitygrafanadestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityGrafanaDestinationType](../../models/components/observabilitygrafanadestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitygrafanadestinationconfig.mdx b/docs/models/components/observabilitygrafanadestinationconfig.mdx index 399b1c5be..43051e2bc 100644 --- a/docs/models/components/observabilitygrafanadestinationconfig.mdx +++ b/docs/models/components/observabilitygrafanadestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityGrafanaDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | ✅ | N/A | -| `BaseURL` | `*string` | ➖ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `InstanceID` | `string` | ✅ | N/A | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | N/A | +| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `InstanceID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitylangfusedestination.mdx b/docs/models/components/observabilitylangfusedestination.mdx index 200b837f7..eb59e746c 100644 --- a/docs/models/components/observabilitylangfusedestination.mdx +++ b/docs/models/components/observabilitylangfusedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityLangfuseDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityLangfuseDestinationConfig](../../models/components/observabilitylangfusedestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityLangfuseDestinationType](../../models/components/observabilitylangfusedestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityLangfuseDestinationConfig](../../models/components/observabilitylangfusedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityLangfuseDestinationType](../../models/components/observabilitylangfusedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitylangfusedestinationconfig.mdx b/docs/models/components/observabilitylangfusedestinationconfig.mdx index a97e36e4a..f21f733b0 100644 --- a/docs/models/components/observabilitylangfusedestinationconfig.mdx +++ b/docs/models/components/observabilitylangfusedestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityLangfuseDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `BaseURL` | `*string` | ➖ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `PublicKey` | `string` | ✅ | N/A | -| `SecretKey` | `string` | ✅ | N/A | \ No newline at end of file +| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `PublicKey` | `string` | :heavy_check_mark: | N/A | +| `SecretKey` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitylangsmithdestination.mdx b/docs/models/components/observabilitylangsmithdestination.mdx index 6fca56362..3df267966 100644 --- a/docs/models/components/observabilitylangsmithdestination.mdx +++ b/docs/models/components/observabilitylangsmithdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityLangsmithDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityLangsmithDestinationConfig](../../models/components/observabilitylangsmithdestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityLangsmithDestinationType](../../models/components/observabilitylangsmithdestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityLangsmithDestinationConfig](../../models/components/observabilitylangsmithdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityLangsmithDestinationType](../../models/components/observabilitylangsmithdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitylangsmithdestinationconfig.mdx b/docs/models/components/observabilitylangsmithdestinationconfig.mdx index 505b9c51f..08ecaf8e3 100644 --- a/docs/models/components/observabilitylangsmithdestinationconfig.mdx +++ b/docs/models/components/observabilitylangsmithdestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityLangsmithDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `APIKey` | `string` | ✅ | N/A | -| `Endpoint` | `*string` | ➖ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `Project` | `*string` | ➖ | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | -| `WorkspaceID` | `*string` | ➖ | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | N/A | +| `Endpoint` | `*string` | :heavy_minus_sign: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `Project` | `*string` | :heavy_minus_sign: | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file diff --git a/docs/models/components/observabilitynewrelicdestination.mdx b/docs/models/components/observabilitynewrelicdestination.mdx index 1b8b48c03..86b101555 100644 --- a/docs/models/components/observabilitynewrelicdestination.mdx +++ b/docs/models/components/observabilitynewrelicdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityNewrelicDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityNewrelicDestinationConfig](../../models/components/observabilitynewrelicdestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityNewrelicDestinationType](../../models/components/observabilitynewrelicdestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityNewrelicDestinationConfig](../../models/components/observabilitynewrelicdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityNewrelicDestinationType](../../models/components/observabilitynewrelicdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitynewrelicdestinationconfig.mdx b/docs/models/components/observabilitynewrelicdestinationconfig.mdx index 3f0c41cfc..380655d73 100644 --- a/docs/models/components/observabilitynewrelicdestinationconfig.mdx +++ b/docs/models/components/observabilitynewrelicdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityNewrelicDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `LicenseKey` | `string` | ✅ | N/A | -| `Region` | [*components.Region](../../models/components/region.mdx) | ➖ | N/A | \ No newline at end of file +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `LicenseKey` | `string` | :heavy_check_mark: | N/A | +| `Region` | [*components.Region](../../models/components/region.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityopikdestination.mdx b/docs/models/components/observabilityopikdestination.mdx index f0fd77f18..53039a8cf 100644 --- a/docs/models/components/observabilityopikdestination.mdx +++ b/docs/models/components/observabilityopikdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityOpikDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityOpikDestinationConfig](../../models/components/observabilityopikdestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityOpikDestinationType](../../models/components/observabilityopikdestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityOpikDestinationConfig](../../models/components/observabilityopikdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityOpikDestinationType](../../models/components/observabilityopikdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityopikdestinationconfig.mdx b/docs/models/components/observabilityopikdestinationconfig.mdx index c5c3c4777..258428c36 100644 --- a/docs/models/components/observabilityopikdestinationconfig.mdx +++ b/docs/models/components/observabilityopikdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityOpikDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | ✅ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `ProjectName` | `string` | ✅ | N/A | -| `Workspace` | `string` | ✅ | N/A | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `ProjectName` | `string` | :heavy_check_mark: | N/A | +| `Workspace` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityotelcollectordestination.mdx b/docs/models/components/observabilityotelcollectordestination.mdx index be970ae05..be974c081 100644 --- a/docs/models/components/observabilityotelcollectordestination.mdx +++ b/docs/models/components/observabilityotelcollectordestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityOtelCollectorDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityOtelCollectorDestinationConfig](../../models/components/observabilityotelcollectordestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityOtelCollectorDestinationType](../../models/components/observabilityotelcollectordestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityOtelCollectorDestinationConfig](../../models/components/observabilityotelcollectordestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityOtelCollectorDestinationType](../../models/components/observabilityotelcollectordestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityotelcollectordestinationconfig.mdx b/docs/models/components/observabilityotelcollectordestinationconfig.mdx index b8e5b18a2..569730f46 100644 --- a/docs/models/components/observabilityotelcollectordestinationconfig.mdx +++ b/docs/models/components/observabilityotelcollectordestinationconfig.mdx @@ -6,5 +6,5 @@ title: "ObservabilityOtelCollectorDestinationConfig" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Endpoint` | `string` | ✅ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers as a JSON object. For Axiom, use \{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"} | \ No newline at end of file +| `Endpoint` | `string` | :heavy_check_mark: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers as a JSON object. For Axiom, use \{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"} | \ No newline at end of file diff --git a/docs/models/components/observabilityposthogdestination.mdx b/docs/models/components/observabilityposthogdestination.mdx index 9a78fec54..08226b8a5 100644 --- a/docs/models/components/observabilityposthogdestination.mdx +++ b/docs/models/components/observabilityposthogdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityPosthogDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityPosthogDestinationConfig](../../models/components/observabilityposthogdestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityPosthogDestinationType](../../models/components/observabilityposthogdestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityPosthogDestinationConfig](../../models/components/observabilityposthogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityPosthogDestinationType](../../models/components/observabilityposthogdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityposthogdestinationconfig.mdx b/docs/models/components/observabilityposthogdestinationconfig.mdx index 7192c799b..15721e28e 100644 --- a/docs/models/components/observabilityposthogdestinationconfig.mdx +++ b/docs/models/components/observabilityposthogdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityPosthogDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | ✅ | N/A | -| `Endpoint` | `*string` | ➖ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | N/A | +| `Endpoint` | `*string` | :heavy_minus_sign: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file diff --git a/docs/models/components/observabilityrampdestination.mdx b/docs/models/components/observabilityrampdestination.mdx index fe80965c6..0332528ca 100644 --- a/docs/models/components/observabilityrampdestination.mdx +++ b/docs/models/components/observabilityrampdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityRampDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityRampDestinationConfig](../../models/components/observabilityrampdestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityRampDestinationType](../../models/components/observabilityrampdestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityRampDestinationConfig](../../models/components/observabilityrampdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityRampDestinationType](../../models/components/observabilityrampdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityrampdestinationconfig.mdx b/docs/models/components/observabilityrampdestinationconfig.mdx index bcc343e33..46d1c2e0f 100644 --- a/docs/models/components/observabilityrampdestinationconfig.mdx +++ b/docs/models/components/observabilityrampdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityRampDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `APIKey` | `string` | ✅ | Generate this in your Ramp integration settings. | -| `BaseURL` | `*string` | ➖ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | Generate this in your Ramp integration settings. | +| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file diff --git a/docs/models/components/observabilitys3destination.mdx b/docs/models/components/observabilitys3destination.mdx index 0021eb888..42c2c817b 100644 --- a/docs/models/components/observabilitys3destination.mdx +++ b/docs/models/components/observabilitys3destination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityS3Destination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityS3DestinationConfig](../../models/components/observabilitys3destinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityS3DestinationType](../../models/components/observabilitys3destinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityS3DestinationConfig](../../models/components/observabilitys3destinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityS3DestinationType](../../models/components/observabilitys3destinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitys3destinationconfig.mdx b/docs/models/components/observabilitys3destinationconfig.mdx index c9c8d1d26..fb2e4f95c 100644 --- a/docs/models/components/observabilitys3destinationconfig.mdx +++ b/docs/models/components/observabilitys3destinationconfig.mdx @@ -6,12 +6,12 @@ title: "ObservabilityS3DestinationConfig" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AccessKeyID` | `string` | ✅ | N/A | -| `BucketName` | `string` | ✅ | N/A | -| `Endpoint` | `*string` | ➖ | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `PathTemplate` | `*string` | ➖ | Template for S3 object path. The filename (\{traceId}-\{timestamp}.json) is automatically appended. Available variables: \{prefix}, \{date}, \{year}, \{month}, \{day}, \{apiKeyName} | -| `Prefix` | `*string` | ➖ | N/A | -| `Region` | `*string` | ➖ | N/A | -| `SecretAccessKey` | `string` | ✅ | N/A | -| `SessionToken` | `*string` | ➖ | N/A | \ No newline at end of file +| `AccessKeyID` | `string` | :heavy_check_mark: | N/A | +| `BucketName` | `string` | :heavy_check_mark: | N/A | +| `Endpoint` | `*string` | :heavy_minus_sign: | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `PathTemplate` | `*string` | :heavy_minus_sign: | Template for S3 object path. The filename (\{traceId}-\{timestamp}.json) is automatically appended. Available variables: \{prefix}, \{date}, \{year}, \{month}, \{day}, \{apiKeyName} | +| `Prefix` | `*string` | :heavy_minus_sign: | N/A | +| `Region` | `*string` | :heavy_minus_sign: | N/A | +| `SecretAccessKey` | `string` | :heavy_check_mark: | N/A | +| `SessionToken` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitysentrydestination.mdx b/docs/models/components/observabilitysentrydestination.mdx index 5227c9a8c..84f50039c 100644 --- a/docs/models/components/observabilitysentrydestination.mdx +++ b/docs/models/components/observabilitysentrydestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilitySentryDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilitySentryDestinationConfig](../../models/components/observabilitysentrydestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilitySentryDestinationType](../../models/components/observabilitysentrydestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilitySentryDestinationConfig](../../models/components/observabilitysentrydestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilitySentryDestinationType](../../models/components/observabilitysentrydestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitysentrydestinationconfig.mdx b/docs/models/components/observabilitysentrydestinationconfig.mdx index 24af6ebc4..110212416 100644 --- a/docs/models/components/observabilitysentrydestinationconfig.mdx +++ b/docs/models/components/observabilitysentrydestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilitySentryDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Dsn` | `string` | ✅ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `OtlpEndpoint` | `string` | ✅ | N/A | \ No newline at end of file +| `Dsn` | `string` | :heavy_check_mark: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `OtlpEndpoint` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitysnowflakedestination.mdx b/docs/models/components/observabilitysnowflakedestination.mdx index 7b4cae505..91813d604 100644 --- a/docs/models/components/observabilitysnowflakedestination.mdx +++ b/docs/models/components/observabilitysnowflakedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilitySnowflakeDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilitySnowflakeDestinationConfig](../../models/components/observabilitysnowflakedestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilitySnowflakeDestinationType](../../models/components/observabilitysnowflakedestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilitySnowflakeDestinationConfig](../../models/components/observabilitysnowflakedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilitySnowflakeDestinationType](../../models/components/observabilitysnowflakedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitysnowflakedestinationconfig.mdx b/docs/models/components/observabilitysnowflakedestinationconfig.mdx index 3eadc916e..09e5f8532 100644 --- a/docs/models/components/observabilitysnowflakedestinationconfig.mdx +++ b/docs/models/components/observabilitysnowflakedestinationconfig.mdx @@ -6,11 +6,11 @@ title: "ObservabilitySnowflakeDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Account` | `string` | ✅ | N/A | -| `Database` | `*string` | ➖ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `Schema` | `*string` | ➖ | N/A | -| `ShouldIncludeCacheWriteTokens` | `*bool` | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `Table` | `*string` | ➖ | N/A | -| `Token` | `string` | ✅ | N/A | -| `Warehouse` | `*string` | ➖ | N/A | \ No newline at end of file +| `Account` | `string` | :heavy_check_mark: | N/A | +| `Database` | `*string` | :heavy_minus_sign: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `Schema` | `*string` | :heavy_minus_sign: | N/A | +| `ShouldIncludeCacheWriteTokens` | `*bool` | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `Table` | `*string` | :heavy_minus_sign: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | +| `Warehouse` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityweavedestination.mdx b/docs/models/components/observabilityweavedestination.mdx index 68991bd31..e86d8edcf 100644 --- a/docs/models/components/observabilityweavedestination.mdx +++ b/docs/models/components/observabilityweavedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityWeaveDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityWeaveDestinationConfig](../../models/components/observabilityweavedestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityWeaveDestinationType](../../models/components/observabilityweavedestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityWeaveDestinationConfig](../../models/components/observabilityweavedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityWeaveDestinationType](../../models/components/observabilityweavedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityweavedestinationconfig.mdx b/docs/models/components/observabilityweavedestinationconfig.mdx index 22ccdc391..f49d7555e 100644 --- a/docs/models/components/observabilityweavedestinationconfig.mdx +++ b/docs/models/components/observabilityweavedestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityWeaveDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | ✅ | N/A | -| `BaseURL` | `*string` | ➖ | N/A | -| `Entity` | `string` | ✅ | N/A | -| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | -| `Project` | `string` | ✅ | N/A | \ No newline at end of file +| `APIKey` | `string` | :heavy_check_mark: | N/A | +| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | +| `Entity` | `string` | :heavy_check_mark: | N/A | +| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | +| `Project` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitywebhookdestination.mdx b/docs/models/components/observabilitywebhookdestination.mdx index 39b02e18f..87113fcd2 100644 --- a/docs/models/components/observabilitywebhookdestination.mdx +++ b/docs/models/components/observabilitywebhookdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityWebhookDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityWebhookDestinationConfig](../../models/components/observabilitywebhookdestinationconfig.mdx) | ✅ | N/A | | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityWebhookDestinationType](../../models/components/observabilitywebhookdestinationtype.mdx) | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityWebhookDestinationConfig](../../models/components/observabilitywebhookdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityWebhookDestinationType](../../models/components/observabilitywebhookdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitywebhookdestinationconfig.mdx b/docs/models/components/observabilitywebhookdestinationconfig.mdx index 297308b72..330f8522f 100644 --- a/docs/models/components/observabilitywebhookdestinationconfig.mdx +++ b/docs/models/components/observabilitywebhookdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityWebhookDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Headers` | map[string]`string` | ➖ | N/A | -| `Method` | [*components.Method](../../models/components/method.mdx) | ➖ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Headers` | map[string]`string` | :heavy_minus_sign: | N/A | +| `Method` | [*components.Method](../../models/components/method.mdx) | :heavy_minus_sign: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifile.mdx b/docs/models/components/openaifile.mdx index 2f564bbfd..ce6c7c6fa 100644 --- a/docs/models/components/openaifile.mdx +++ b/docs/models/components/openaifile.mdx @@ -9,11 +9,11 @@ A stored file in OpenAI's Files API shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileShape](../../models/components/openaifileshape.mdx) | ✅ | N/A | -| `Bytes` | `int64` | ✅ | N/A | -| `CreatedAt` | `int64` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Object` | [components.OpenAIFileObject](../../models/components/openaifileobject.mdx) | ✅ | N/A | -| `Purpose` | [components.Purpose](../../models/components/purpose.mdx) | ✅ | N/A | -| `Status` | [components.OpenAIFileStatus](../../models/components/openaifilestatus.mdx) | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.OpenAIFileShape](../../models/components/openaifileshape.mdx) | :heavy_check_mark: | N/A | +| `Bytes` | `int64` | :heavy_check_mark: | N/A | +| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Object` | [components.OpenAIFileObject](../../models/components/openaifileobject.mdx) | :heavy_check_mark: | N/A | +| `Purpose` | [components.Purpose](../../models/components/purpose.mdx) | :heavy_check_mark: | N/A | +| `Status` | [components.OpenAIFileStatus](../../models/components/openaifilestatus.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifiledeleted.mdx b/docs/models/components/openaifiledeleted.mdx index 1636294f7..5e9e8bb9a 100644 --- a/docs/models/components/openaifiledeleted.mdx +++ b/docs/models/components/openaifiledeleted.mdx @@ -9,7 +9,7 @@ Deletion result in OpenAI's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileDeletedShape](../../models/components/openaifiledeletedshape.mdx) | ✅ | N/A | -| `Deleted` | `bool` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Object` | [components.OpenAIFileDeletedObject](../../models/components/openaifiledeletedobject.mdx) | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.OpenAIFileDeletedShape](../../models/components/openaifiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `Deleted` | `bool` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Object` | [components.OpenAIFileDeletedObject](../../models/components/openaifiledeletedobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifilelist.mdx b/docs/models/components/openaifilelist.mdx index fe43387a0..4222fe91c 100644 --- a/docs/models/components/openaifilelist.mdx +++ b/docs/models/components/openaifilelist.mdx @@ -9,9 +9,9 @@ A page of files in OpenAI's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileListShape](../../models/components/openaifilelistshape.mdx) | ✅ | N/A | -| `Data` | [][components.OpenAIFile](../../models/components/openaifile.mdx) | ✅ | N/A | -| `FirstID` | `*string` | ✅ | N/A | -| `HasMore` | `bool` | ✅ | N/A | -| `LastID` | `*string` | ✅ | N/A | -| `Object` | [components.OpenAIFileListObject](../../models/components/openaifilelistobject.mdx) | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.OpenAIFileListShape](../../models/components/openaifilelistshape.mdx) | :heavy_check_mark: | N/A | +| `Data` | [][components.OpenAIFile](../../models/components/openaifile.mdx) | :heavy_check_mark: | N/A | +| `FirstID` | `*string` | :heavy_check_mark: | N/A | +| `HasMore` | `bool` | :heavy_check_mark: | N/A | +| `LastID` | `*string` | :heavy_check_mark: | N/A | +| `Object` | [components.OpenAIFileListObject](../../models/components/openaifilelistobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsecustomtoolcall.mdx b/docs/models/components/openairesponsecustomtoolcall.mdx index 072ffa95a..4a6a8d1a0 100644 --- a/docs/models/components/openairesponsecustomtoolcall.mdx +++ b/docs/models/components/openairesponsecustomtoolcall.mdx @@ -6,10 +6,10 @@ title: "OpenAIResponseCustomToolCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Input` | `string` | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Type` | [components.OpenAIResponseCustomToolCallType](../../models/components/openairesponsecustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Input` | `string` | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Type` | [components.OpenAIResponseCustomToolCallType](../../models/components/openairesponsecustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openairesponsecustomtoolcalloutput.mdx b/docs/models/components/openairesponsecustomtoolcalloutput.mdx index cbc1368d9..726441b3b 100644 --- a/docs/models/components/openairesponsecustomtoolcalloutput.mdx +++ b/docs/models/components/openairesponsecustomtoolcalloutput.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseCustomToolCallOutput" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | ✅ | N/A | -| `ID` | `*string` | ➖ | N/A | -| `Output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../../models/components/openairesponsecustomtoolcalloutputoutput2.mdx) | ✅ | N/A | -| `Type` | [components.OpenAIResponseCustomToolCallOutputType](../../models/components/openairesponsecustomtoolcalloutputtype.mdx) | ✅ | N/A | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | +| `ID` | `*string` | :heavy_minus_sign: | N/A | +| `Output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../../models/components/openairesponsecustomtoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.OpenAIResponseCustomToolCallOutputType](../../models/components/openairesponsecustomtoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsefunctiontoolcall.mdx b/docs/models/components/openairesponsefunctiontoolcall.mdx index 1c005d874..ebfcfef97 100644 --- a/docs/models/components/openairesponsefunctiontoolcall.mdx +++ b/docs/models/components/openairesponsefunctiontoolcall.mdx @@ -6,13 +6,13 @@ title: "OpenAIResponseFunctionToolCall" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | ✅ | N/A | | -| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ➖ | N/A | completed | -| `SubagentID` | `*string` | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `SubagentItems` | [][components.OpenAIResponseFunctionToolCallSubagentItem](../../models/components/openairesponsefunctiontoolcallsubagentitem.mdx) | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | -| `Type` | [components.OpenAIResponseFunctionToolCallType](../../models/components/openairesponsefunctiontoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | | +| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | +| `SubagentID` | `*string` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `SubagentItems` | [][components.OpenAIResponseFunctionToolCallSubagentItem](../../models/components/openairesponsefunctiontoolcallsubagentitem.mdx) | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | +| `Type` | [components.OpenAIResponseFunctionToolCallType](../../models/components/openairesponsefunctiontoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openairesponsefunctiontoolcalloutput.mdx b/docs/models/components/openairesponsefunctiontoolcalloutput.mdx index 6174bf4b6..e464d154c 100644 --- a/docs/models/components/openairesponsefunctiontoolcalloutput.mdx +++ b/docs/models/components/openairesponsefunctiontoolcalloutput.mdx @@ -6,8 +6,8 @@ title: "OpenAIResponseFunctionToolCallOutput" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../../models/components/openairesponsefunctiontoolcalloutputoutput2.mdx) | ✅ | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | -| `Type` | [components.OpenAIResponseFunctionToolCallOutputType](../../models/components/openairesponsefunctiontoolcalloutputtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../../models/components/openairesponsefunctiontoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.OpenAIResponseFunctionToolCallOutputType](../../models/components/openairesponsefunctiontoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openairesponsefunctiontoolcallsubagentitem.mdx b/docs/models/components/openairesponsefunctiontoolcallsubagentitem.mdx index d293745ed..6d1d9b61b 100644 --- a/docs/models/components/openairesponsefunctiontoolcallsubagentitem.mdx +++ b/docs/models/components/openairesponsefunctiontoolcallsubagentitem.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponseFunctionToolCallSubagentItem" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Type` | `string` | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponseinputmessageitem.mdx b/docs/models/components/openairesponseinputmessageitem.mdx index 9bd3d0ad8..8d8a2353e 100644 --- a/docs/models/components/openairesponseinputmessageitem.mdx +++ b/docs/models/components/openairesponseinputmessageitem.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseInputMessageItem" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Content` | [][components.OpenAIResponseInputMessageItemContent](../../models/components/openairesponseinputmessageitemcontent.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Role` | [components.OpenAIResponseInputMessageItemRoleUnion](../../models/components/openairesponseinputmessageitemroleunion.mdx) | ✅ | N/A | -| `Type` | [*components.OpenAIResponseInputMessageItemType](../../models/components/openairesponseinputmessageitemtype.mdx) | ➖ | N/A | \ No newline at end of file +| `Content` | [][components.OpenAIResponseInputMessageItemContent](../../models/components/openairesponseinputmessageitemcontent.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Role` | [components.OpenAIResponseInputMessageItemRoleUnion](../../models/components/openairesponseinputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | +| `Type` | [*components.OpenAIResponseInputMessageItemType](../../models/components/openairesponseinputmessageitemtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsesrefusalcontent.mdx b/docs/models/components/openairesponsesrefusalcontent.mdx index 4f6b357f1..e412ff668 100644 --- a/docs/models/components/openairesponsesrefusalcontent.mdx +++ b/docs/models/components/openairesponsesrefusalcontent.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponsesRefusalContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Refusal` | `string` | ✅ | N/A | -| `Type` | [components.OpenAIResponsesRefusalContentType](../../models/components/openairesponsesrefusalcontenttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Refusal` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.OpenAIResponsesRefusalContentType](../../models/components/openairesponsesrefusalcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoice.mdx b/docs/models/components/openairesponsestoolchoice.mdx index 849d433a6..cfeeb25de 100644 --- a/docs/models/components/openairesponsestoolchoice.mdx +++ b/docs/models/components/openairesponsestoolchoice.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoice" | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Type` | [components.Type](../../models/components/type.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.Type](../../models/components/type.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoiceapplypatch.mdx b/docs/models/components/openairesponsestoolchoiceapplypatch.mdx index 5485631f4..d37e00a52 100644 --- a/docs/models/components/openairesponsestoolchoiceapplypatch.mdx +++ b/docs/models/components/openairesponsestoolchoiceapplypatch.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceApplyPatch" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../../models/components/openairesponsestoolchoicetypeapplypatch.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../../models/components/openairesponsestoolchoicetypeapplypatch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoicefunction.mdx b/docs/models/components/openairesponsestoolchoicefunction.mdx index 831b77006..f9607fb9b 100644 --- a/docs/models/components/openairesponsestoolchoicefunction.mdx +++ b/docs/models/components/openairesponsestoolchoicefunction.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponsesToolChoiceFunction" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | ✅ | N/A | -| `Type` | [components.OpenAIResponsesToolChoiceTypeFunction](../../models/components/openairesponsestoolchoicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.OpenAIResponsesToolChoiceTypeFunction](../../models/components/openairesponsestoolchoicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoiceshell.mdx b/docs/models/components/openairesponsestoolchoiceshell.mdx index ab5536f78..f964fb9c6 100644 --- a/docs/models/components/openairesponsestoolchoiceshell.mdx +++ b/docs/models/components/openairesponsestoolchoiceshell.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceShell" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OpenAIResponsesToolChoiceTypeShell](../../models/components/openairesponsestoolchoicetypeshell.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponsesToolChoiceTypeShell](../../models/components/openairesponsestoolchoicetypeshell.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openresponsescreatedevent.mdx b/docs/models/components/openresponsescreatedevent.mdx index d70315a60..50c252482 100644 --- a/docs/models/components/openresponsescreatedevent.mdx +++ b/docs/models/components/openresponsescreatedevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is created | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.OpenResponsesCreatedEventType](../../models/components/openresponsescreatedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.OpenResponsesCreatedEventType](../../models/components/openresponsescreatedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openresponseserrorfield.mdx b/docs/models/components/openresponseserrorfield.mdx index fc3ef43a7..89bbef4fb 100644 --- a/docs/models/components/openresponseserrorfield.mdx +++ b/docs/models/components/openresponseserrorfield.mdx @@ -9,6 +9,6 @@ Error of a failed response; `metadata` carries OpenRouter-specific details. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Code` | [components.CodeEnum](../../models/components/codeenum.mdx) | ✅ | N/A | | -| `Message` | `string` | ✅ | N/A | | -| `Metadata` | [*components.OpenResponsesErrorMetadata](../../models/components/openresponseserrormetadata.mdx) | ➖ | OpenRouter-specific details of a failed response, such as the alignment object of an alignment error. | \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
} | \ No newline at end of file +| `Code` | [components.CodeEnum](../../models/components/codeenum.mdx) | :heavy_check_mark: | N/A | | +| `Message` | `string` | :heavy_check_mark: | N/A | | +| `Metadata` | [*components.OpenResponsesErrorMetadata](../../models/components/openresponseserrormetadata.mdx) | :heavy_minus_sign: | OpenRouter-specific details of a failed response, such as the alignment object of an alignment error. | \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
} | \ No newline at end of file diff --git a/docs/models/components/openresponseserrormetadata.mdx b/docs/models/components/openresponseserrormetadata.mdx index d7d330430..9203693a8 100644 --- a/docs/models/components/openresponseserrormetadata.mdx +++ b/docs/models/components/openresponseserrormetadata.mdx @@ -9,4 +9,4 @@ OpenRouter-specific details of a failed response, such as the alignment object o | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Alignment` | [*components.OpenResponsesErrorMetadataAlignment](../../models/components/openresponseserrormetadataalignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | \ No newline at end of file +| `Alignment` | [*components.OpenResponsesErrorMetadataAlignment](../../models/components/openresponseserrormetadataalignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | \ No newline at end of file diff --git a/docs/models/components/openresponseserrormetadataalignment.mdx b/docs/models/components/openresponseserrormetadataalignment.mdx index 528e65235..70a97f45a 100644 --- a/docs/models/components/openresponseserrormetadataalignment.mdx +++ b/docs/models/components/openresponseserrormetadataalignment.mdx @@ -9,5 +9,5 @@ Beta. The result of the alignment plugin for this request; the shape may change. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Calls` | [][components.AlignmentCallRecord](../../models/components/alignmentcallrecord.mdx) | ✅ | One record per evaluated assistant message of the request, in the order the messages were produced. | -| `Rejected` | [*components.AlignmentRejected](../../models/components/alignmentrejected.mdx) | ➖ | N/A | \ No newline at end of file +| `Calls` | [][components.AlignmentCallRecord](../../models/components/alignmentcallrecord.mdx) | :heavy_check_mark: | One record per evaluated assistant message of the request, in the order the messages were produced. | +| `Rejected` | [*components.AlignmentRejected](../../models/components/alignmentrejected.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/openresponsesinprogressevent.mdx b/docs/models/components/openresponsesinprogressevent.mdx index e5a533e82..e08c1e18e 100644 --- a/docs/models/components/openresponsesinprogressevent.mdx +++ b/docs/models/components/openresponsesinprogressevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is in progress | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.OpenResponsesInProgressEventType](../../models/components/openresponsesinprogresseventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.OpenResponsesInProgressEventType](../../models/components/openresponsesinprogresseventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openresponsesresult.mdx b/docs/models/components/openresponsesresult.mdx index a4a774f3d..70ce3d7e1 100644 --- a/docs/models/components/openresponsesresult.mdx +++ b/docs/models/components/openresponsesresult.mdx @@ -9,41 +9,41 @@ Complete non-streaming response from the Responses API | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Background` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `CompletedAt` | `*int64` | ✅ | N/A | | -| `CreatedAt` | `int64` | ✅ | N/A | | -| `Error` | [*components.OpenResponsesErrorField](../../models/components/openresponseserrorfield.mdx) | ✅ | Error of a failed response; `metadata` carries OpenRouter-specific details. | \{
"code": "server_error",
"message": "Alignment plugin: the reply could not be evaluated: evaluator_error",
"metadata": \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
}
} | -| `FrequencyPenalty` | `*float64` | ✅ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `IncompleteDetails` | [*components.IncompleteDetails](../../models/components/incompletedetails.mdx) | ✅ | N/A | \{
"reason": "max_output_tokens"
} | -| `Instructions` | [*components.BaseInputsUnion](../../models/components/baseinputsunion.mdx) | ✅ | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | -| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | -| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | -| `Metadata` | map[string]`string` | ✅ | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | -| `Model` | `string` | ✅ | N/A | | -| `Object` | [components.OpenResponsesResultObject](../../models/components/openresponsesresultobject.mdx) | ✅ | N/A | | -| `Output` | [][components.OutputItems](../../models/components/outputitems.mdx) | ✅ | N/A | | -| `OutputText` | `*string` | ➖ | N/A | | -| `ParallelToolCalls` | `bool` | ✅ | N/A | | -| `PresencePenalty` | `*float64` | ✅ | N/A | | -| `PreviousResponseID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `Reasoning` | optionalnullable.OptionalNullable[[components.BaseReasoningConfig](../../models/components/basereasoningconfig.mdx)] | ➖ | N/A | \{
"effort": "medium",
"summary": "auto"
} | -| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Status` | [components.OpenAIResponsesResponseStatus](../../models/components/openairesponsesresponsestatus.mdx) | ✅ | N/A | completed | -| `Store` | `*bool` | ➖ | N/A | | -| `Temperature` | `*float64` | ✅ | N/A | | -| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `ToolChoice` | [components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | ✅ | N/A | auto | -| `Tools` | [][components.OpenResponsesResultToolUnion](../../models/components/openresponsesresulttoolunion.mdx) | ✅ | N/A | | -| `TopLogprobs` | `*int64` | ➖ | N/A | | -| `TopP` | `*float64` | ✅ | N/A | | -| `Truncation` | optionalnullable.OptionalNullable[[components.Truncation](../../models/components/truncation.mdx)] | ➖ | N/A | auto | -| `Usage` | optionalnullable.OptionalNullable[[components.Usage](../../models/components/usage.mdx)] | ➖ | Token usage information for the response | \{
"cost": 0.0012,
"cost_details": \{
"upstream_inference_cost": null,
"upstream_inference_input_cost": 0.0008,
"upstream_inference_output_cost": 0.0004
},
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
} | -| `User` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Alignment` | [*components.Alignment](../../models/components/alignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | -| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file +| `Background` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `CompletedAt` | `*int64` | :heavy_check_mark: | N/A | | +| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | | +| `Error` | [*components.OpenResponsesErrorField](../../models/components/openresponseserrorfield.mdx) | :heavy_check_mark: | Error of a failed response; `metadata` carries OpenRouter-specific details. | \{
"code": "server_error",
"message": "Alignment plugin: the reply could not be evaluated: evaluator_error",
"metadata": \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
}
} | +| `FrequencyPenalty` | `*float64` | :heavy_check_mark: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `IncompleteDetails` | [*components.IncompleteDetails](../../models/components/incompletedetails.mdx) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | +| `Instructions` | [*components.BaseInputsUnion](../../models/components/baseinputsunion.mdx) | :heavy_check_mark: | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | +| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | +| `Metadata` | map[string]`string` | :heavy_check_mark: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `Object` | [components.OpenResponsesResultObject](../../models/components/openresponsesresultobject.mdx) | :heavy_check_mark: | N/A | | +| `Output` | [][components.OutputItems](../../models/components/outputitems.mdx) | :heavy_check_mark: | N/A | | +| `OutputText` | `*string` | :heavy_minus_sign: | N/A | | +| `ParallelToolCalls` | `bool` | :heavy_check_mark: | N/A | | +| `PresencePenalty` | `*float64` | :heavy_check_mark: | N/A | | +| `PreviousResponseID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `Reasoning` | optionalnullable.OptionalNullable[[components.BaseReasoningConfig](../../models/components/basereasoningconfig.mdx)] | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | +| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Status` | [components.OpenAIResponsesResponseStatus](../../models/components/openairesponsesresponsestatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Store` | `*bool` | :heavy_minus_sign: | N/A | | +| `Temperature` | `*float64` | :heavy_check_mark: | N/A | | +| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `ToolChoice` | [components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | :heavy_check_mark: | N/A | auto | +| `Tools` | [][components.OpenResponsesResultToolUnion](../../models/components/openresponsesresulttoolunion.mdx) | :heavy_check_mark: | N/A | | +| `TopLogprobs` | `*int64` | :heavy_minus_sign: | N/A | | +| `TopP` | `*float64` | :heavy_check_mark: | N/A | | +| `Truncation` | optionalnullable.OptionalNullable[[components.Truncation](../../models/components/truncation.mdx)] | :heavy_minus_sign: | N/A | auto | +| `Usage` | optionalnullable.OptionalNullable[[components.Usage](../../models/components/usage.mdx)] | :heavy_minus_sign: | Token usage information for the response | \{
"cost": 0.0012,
"cost_details": \{
"upstream_inference_cost": null,
"upstream_inference_input_cost": 0.0008,
"upstream_inference_output_cost": 0.0004
},
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
} | +| `User` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Alignment` | [*components.Alignment](../../models/components/alignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | +| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file diff --git a/docs/models/components/openresponsesresulttoolfunction.mdx b/docs/models/components/openresponsesresulttoolfunction.mdx index c35034136..d1ed93467 100644 --- a/docs/models/components/openresponsesresulttoolfunction.mdx +++ b/docs/models/components/openresponsesresulttoolfunction.mdx @@ -9,10 +9,10 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Parameters` | map[string]`any` | ✅ | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `Type` | [components.OpenResponsesResultType](../../models/components/openresponsesresulttype.mdx) | ✅ | N/A | | -| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.OpenResponsesResultType](../../models/components/openresponsesresulttype.mdx) | :heavy_check_mark: | N/A | | +| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/components/openrouterfile.mdx b/docs/models/components/openrouterfile.mdx index b9110f68f..ec87a6284 100644 --- a/docs/models/components/openrouterfile.mdx +++ b/docs/models/components/openrouterfile.mdx @@ -9,11 +9,11 @@ A stored file in the OpenRouter superset shape: Anthropic-shaped, plus OpenRoute | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileShape](../../models/components/openrouterfileshape.mdx) | ✅ | N/A | -| `CreatedAt` | `string` | ✅ | N/A | -| `Downloadable` | `bool` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `MimeType` | `string` | ✅ | N/A | -| `SizeBytes` | `int64` | ✅ | N/A | -| `Type` | [components.OpenRouterFileType](../../models/components/openrouterfiletype.mdx) | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.OpenRouterFileShape](../../models/components/openrouterfileshape.mdx) | :heavy_check_mark: | N/A | +| `CreatedAt` | `string` | :heavy_check_mark: | N/A | +| `Downloadable` | `bool` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `MimeType` | `string` | :heavy_check_mark: | N/A | +| `SizeBytes` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.OpenRouterFileType](../../models/components/openrouterfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openrouterfiledeleted.mdx b/docs/models/components/openrouterfiledeleted.mdx index d1046da35..16d6aea4c 100644 --- a/docs/models/components/openrouterfiledeleted.mdx +++ b/docs/models/components/openrouterfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in the OpenRouter shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileDeletedShape](../../models/components/openrouterfiledeletedshape.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Type` | [components.OpenRouterFileDeletedType](../../models/components/openrouterfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.OpenRouterFileDeletedShape](../../models/components/openrouterfiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.OpenRouterFileDeletedType](../../models/components/openrouterfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openrouterfilelist.mdx b/docs/models/components/openrouterfilelist.mdx index 2a6bef713..8b4ef8de0 100644 --- a/docs/models/components/openrouterfilelist.mdx +++ b/docs/models/components/openrouterfilelist.mdx @@ -9,9 +9,9 @@ A page of files in the OpenRouter shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileListShape](../../models/components/openrouterfilelistshape.mdx) | ✅ | N/A | -| `Cursor` | `*string` | ✅ | Opaque cursor for the next page; null when there are no more results. | -| `Data` | [][components.OpenRouterFile](../../models/components/openrouterfile.mdx) | ✅ | N/A | -| `FirstID` | `*string` | ✅ | N/A | -| `HasMore` | `bool` | ✅ | N/A | -| `LastID` | `*string` | ✅ | N/A | \ No newline at end of file +| `Shape` | [components.OpenRouterFileListShape](../../models/components/openrouterfilelistshape.mdx) | :heavy_check_mark: | N/A | +| `Cursor` | `*string` | :heavy_check_mark: | Opaque cursor for the next page; null when there are no more results. | +| `Data` | [][components.OpenRouterFile](../../models/components/openrouterfile.mdx) | :heavy_check_mark: | N/A | +| `FirstID` | `*string` | :heavy_check_mark: | N/A | +| `HasMore` | `bool` | :heavy_check_mark: | N/A | +| `LastID` | `*string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openroutermetadata.mdx b/docs/models/components/openroutermetadata.mdx index 21e5e404b..79f760106 100644 --- a/docs/models/components/openroutermetadata.mdx +++ b/docs/models/components/openroutermetadata.mdx @@ -6,14 +6,14 @@ title: "OpenRouterMetadata" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Attempt` | `int64` | ✅ | N/A | | -| `Attempts` | [][components.RouterAttempt](../../models/components/routerattempt.mdx) | ➖ | N/A | | -| `Endpoints` | [components.EndpointsMetadata](../../models/components/endpointsmetadata.mdx) | ✅ | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | -| `GenerationTime` | `*int64` | ➖ | Milliseconds measured for the generation, from dispatching the upstream request until its response body ended. Divide the completion token count by this for throughput. Absent when no upstream request was dispatched. | 2016 | -| `IsBYOK` | `bool` | ✅ | N/A | | -| `Params` | [*components.RouterParams](../../models/components/routerparams.mdx) | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | -| `Pipeline` | [][components.PipelineStage](../../models/components/pipelinestage.mdx) | ➖ | N/A | | -| `Region` | `*string` | ✅ | N/A | | -| `Requested` | `string` | ✅ | N/A | | -| `Strategy` | [components.RoutingStrategy](../../models/components/routingstrategy.mdx) | ✅ | N/A | direct | -| `Summary` | `string` | ✅ | N/A | | \ No newline at end of file +| `Attempt` | `int64` | :heavy_check_mark: | N/A | | +| `Attempts` | [][components.RouterAttempt](../../models/components/routerattempt.mdx) | :heavy_minus_sign: | N/A | | +| `Endpoints` | [components.EndpointsMetadata](../../models/components/endpointsmetadata.mdx) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | +| `GenerationTime` | `*int64` | :heavy_minus_sign: | Milliseconds measured for the generation, from dispatching the upstream request until its response body ended. Divide the completion token count by this for throughput. Absent when no upstream request was dispatched. | 2016 | +| `IsBYOK` | `bool` | :heavy_check_mark: | N/A | | +| `Params` | [*components.RouterParams](../../models/components/routerparams.mdx) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | +| `Pipeline` | [][components.PipelineStage](../../models/components/pipelinestage.mdx) | :heavy_minus_sign: | N/A | | +| `Region` | `*string` | :heavy_check_mark: | N/A | | +| `Requested` | `string` | :heavy_check_mark: | N/A | | +| `Strategy` | [components.RoutingStrategy](../../models/components/routingstrategy.mdx) | :heavy_check_mark: | N/A | direct | +| `Summary` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openrouterwebsearchservertool.mdx b/docs/models/components/openrouterwebsearchservertool.mdx index 14a848074..acd808b40 100644 --- a/docs/models/components/openrouterwebsearchservertool.mdx +++ b/docs/models/components/openrouterwebsearchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `Type` | [components.OpenRouterWebSearchServerToolType](../../models/components/openrouterwebsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `Type` | [components.OpenRouterWebSearchServerToolType](../../models/components/openrouterwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/oranthropicbashtoolresult.mdx b/docs/models/components/oranthropicbashtoolresult.mdx index 03e79850d..2fdf42921 100644 --- a/docs/models/components/oranthropicbashtoolresult.mdx +++ b/docs/models/components/oranthropicbashtoolresult.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:bash` call executed in the OpenRouter sandbox (`engine: | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `Content` | map[string]`any` | ✅ | N/A | -| `Files` | [][components.ORAnthropicBashToolResultFile](../../models/components/oranthropicbashtoolresultfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `ToolUseID` | `string` | ✅ | N/A | -| `Type` | [components.ORAnthropicBashToolResultTypeOpenrouterBashToolResult](../../models/components/oranthropicbashtoolresulttypeopenrouterbashtoolresult.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `Content` | map[string]`any` | :heavy_check_mark: | N/A | +| `Files` | [][components.ORAnthropicBashToolResultFile](../../models/components/oranthropicbashtoolresultfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ORAnthropicBashToolResultTypeOpenrouterBashToolResult](../../models/components/oranthropicbashtoolresulttypeopenrouterbashtoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/oranthropicbashtoolresultfile.mdx b/docs/models/components/oranthropicbashtoolresultfile.mdx index 2755ed07d..b2a83c6c1 100644 --- a/docs/models/components/oranthropicbashtoolresultfile.mdx +++ b/docs/models/components/oranthropicbashtoolresultfile.mdx @@ -6,9 +6,9 @@ title: "ORAnthropicBashToolResultFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Type` | [components.ORAnthropicBashToolResultTypeContainerFileCitation](../../models/components/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ORAnthropicBashToolResultTypeContainerFileCitation](../../models/components/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/oranthropicservertooluseblock.mdx b/docs/models/components/oranthropicservertooluseblock.mdx index 3582fc062..b6e5baacf 100644 --- a/docs/models/components/oranthropicservertooluseblock.mdx +++ b/docs/models/components/oranthropicservertooluseblock.mdx @@ -6,8 +6,8 @@ title: "ORAnthropicServerToolUseBlock" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Caller` | optionalnullable.OptionalNullable[[components.ORAnthropicNullableCaller](../../models/components/oranthropicnullablecaller.mdx)] | ➖ | N/A | \{
"type": "direct"
} | -| `ID` | `string` | ✅ | N/A | | -| `Input` | `any` | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Type` | [components.ORAnthropicServerToolUseBlockType](../../models/components/oranthropicservertooluseblocktype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Caller` | optionalnullable.OptionalNullable[[components.ORAnthropicNullableCaller](../../models/components/oranthropicnullablecaller.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "direct"
} | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Input` | `any` | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.ORAnthropicServerToolUseBlockType](../../models/components/oranthropicservertooluseblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/oranthropicshelltoolresult.mdx b/docs/models/components/oranthropicshelltoolresult.mdx index 70221c8a9..e8ea31460 100644 --- a/docs/models/components/oranthropicshelltoolresult.mdx +++ b/docs/models/components/oranthropicshelltoolresult.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:shell` call executed in the OpenRouter sandbox | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `Content` | map[string]`any` | ✅ | N/A | -| `Files` | [][components.ORAnthropicShellToolResultFile](../../models/components/oranthropicshelltoolresultfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `ToolUseID` | `string` | ✅ | N/A | -| `Type` | [components.ORAnthropicShellToolResultTypeOpenrouterShellToolResult](../../models/components/oranthropicshelltoolresulttypeopenroutershelltoolresult.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `Content` | map[string]`any` | :heavy_check_mark: | N/A | +| `Files` | [][components.ORAnthropicShellToolResultFile](../../models/components/oranthropicshelltoolresultfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `ToolUseID` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ORAnthropicShellToolResultTypeOpenrouterShellToolResult](../../models/components/oranthropicshelltoolresulttypeopenroutershelltoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/oranthropicshelltoolresultfile.mdx b/docs/models/components/oranthropicshelltoolresultfile.mdx index 21357d7eb..6cb4fdaf3 100644 --- a/docs/models/components/oranthropicshelltoolresultfile.mdx +++ b/docs/models/components/oranthropicshelltoolresultfile.mdx @@ -6,9 +6,9 @@ title: "ORAnthropicShellToolResultFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `ContainerID` | `string` | ✅ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Type` | [components.ORAnthropicShellToolResultTypeContainerFileCitation](../../models/components/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ORAnthropicShellToolResultTypeContainerFileCitation](../../models/components/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/organizationsettings.mdx b/docs/models/components/organizationsettings.mdx index b8152295f..6e05ea3fe 100644 --- a/docs/models/components/organizationsettings.mdx +++ b/docs/models/components/organizationsettings.mdx @@ -6,5 +6,5 @@ title: "OrganizationSettings" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | -| `IsFilteredModelCatalogEnabled` | `bool` | ✅ | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | +| `IsFilteredModelCatalogEnabled` | `bool` | :heavy_check_mark: | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file diff --git a/docs/models/components/outcomeexit.mdx b/docs/models/components/outcomeexit.mdx index 428d204d0..4703060d6 100644 --- a/docs/models/components/outcomeexit.mdx +++ b/docs/models/components/outcomeexit.mdx @@ -6,6 +6,6 @@ title: "OutcomeExit" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `ExitCode` | `int64` | ✅ | N/A | -| `Type` | [components.TypeExit](../../models/components/typeexit.mdx) | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `ExitCode` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.TypeExit](../../models/components/typeexit.mdx) | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/outcometimeout.mdx b/docs/models/components/outcometimeout.mdx index 395651cd4..8b5a623f8 100644 --- a/docs/models/components/outcometimeout.mdx +++ b/docs/models/components/outcometimeout.mdx @@ -6,5 +6,5 @@ title: "OutcomeTimeout" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Type` | [components.TypeTimeout](../../models/components/typetimeout.mdx) | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Type` | [components.TypeTimeout](../../models/components/typetimeout.mdx) | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputadvisorservertoolitem.mdx b/docs/models/components/outputadvisorservertoolitem.mdx index 1e26be575..ddbedd13f 100644 --- a/docs/models/components/outputadvisorservertoolitem.mdx +++ b/docs/models/components/outputadvisorservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:advisor server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Advice` | `*string` | ➖ | The advisor model's response (the advice text returned to the executor). | | -| `Error` | `*string` | ➖ | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | -| `ID` | `*string` | ➖ | N/A | | -| `InstanceName` | `*string` | ➖ | Provider-safe function name of the specific advisor instance that produced this item (e.g. `openrouter_advisor__1`). Present only when more than one advisor tool is configured; omitted for the default single advisor. Echo this field back unchanged so the advisor's cross-request memory stays namespaced to the correct instance. This identity is positional: it is derived from the index of the advisor entry in the request `tools` array, so clients must keep the order of advisor tool entries stable across requests in a conversation. Reordering or inserting advisor entries shifts these names and causes each advisor's cross-request memory to be attributed to the wrong instance. | openrouter_advisor__1 | -| `Model` | `*string` | ➖ | Slug of the advisor model that was consulted. | | -| `Prompt` | `*string` | ➖ | The prompt the executor sent to the advisor. | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputAdvisorServerToolItemType](../../models/components/outputadvisorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Advice` | `*string` | :heavy_minus_sign: | The advisor model's response (the advice text returned to the executor). | | +| `Error` | `*string` | :heavy_minus_sign: | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `InstanceName` | `*string` | :heavy_minus_sign: | Provider-safe function name of the specific advisor instance that produced this item (e.g. `openrouter_advisor__1`). Present only when more than one advisor tool is configured; omitted for the default single advisor. Echo this field back unchanged so the advisor's cross-request memory stays namespaced to the correct instance. This identity is positional: it is derived from the index of the advisor entry in the request `tools` array, so clients must keep the order of advisor tool entries stable across requests in a conversation. Reordering or inserting advisor entries shifts these names and causes each advisor's cross-request memory to be attributed to the wrong instance. | openrouter_advisor__1 | +| `Model` | `*string` | :heavy_minus_sign: | Slug of the advisor model that was consulted. | | +| `Prompt` | `*string` | :heavy_minus_sign: | The prompt the executor sent to the advisor. | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputAdvisorServerToolItemType](../../models/components/outputadvisorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputapplypatchcallitem.mdx b/docs/models/components/outputapplypatchcallitem.mdx index e5b5a4424..fba577351 100644 --- a/docs/models/components/outputapplypatchcallitem.mdx +++ b/docs/models/components/outputapplypatchcallitem.mdx @@ -9,8 +9,8 @@ A native `apply_patch_call` output item matching OpenAI's Responses API shape. E | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | ✅ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `Status` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | -| `Type` | [components.OutputApplyPatchCallItemType](../../models/components/outputapplypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `Status` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | +| `Type` | [components.OutputApplyPatchCallItemType](../../models/components/outputapplypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputapplypatchservertoolitem.mdx b/docs/models/components/outputapplypatchservertoolitem.mdx index b3dac23b2..cb6c958d8 100644 --- a/docs/models/components/outputapplypatchservertoolitem.mdx +++ b/docs/models/components/outputapplypatchservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:apply_patch server tool output item. The turn halts when validatio | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `*string` | ➖ | N/A | | -| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | ➖ | N/A | | -| `Operation` | [*components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | ➖ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputApplyPatchServerToolItemType](../../models/components/outputapplypatchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CallID` | `*string` | :heavy_minus_sign: | N/A | | +| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Operation` | [*components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :heavy_minus_sign: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputApplyPatchServerToolItemType](../../models/components/outputapplypatchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputbashservertoolitem.mdx b/docs/models/components/outputbashservertoolitem.mdx index 255fd99f9..35ef9e315 100644 --- a/docs/models/components/outputbashservertoolitem.mdx +++ b/docs/models/components/outputbashservertoolitem.mdx @@ -9,15 +9,15 @@ An openrouter:bash server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. | | -| `CallID` | optionalnullable.OptionalNullable[`string`] | ➖ | The model-generated tool call id from the originating turn. | | -| `Command` | `*string` | ➖ | N/A | | -| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `Error` | `*string` | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. A non-zero `exitCode` is a command failure, not a tool failure. | | -| `ExitCode` | `*int64` | ➖ | N/A | | -| `Files` | [][components.OutputBashServerToolItemFile](../../models/components/outputbashservertoolitemfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `ID` | `*string` | ➖ | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Stderr` | `*string` | ➖ | N/A | | -| `Stdout` | `*string` | ➖ | N/A | | -| `Type` | [components.OutputBashServerToolItemTypeOpenrouterBash](../../models/components/outputbashservertoolitemtypeopenrouterbash.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | +| `CallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | +| `Command` | `*string` | :heavy_minus_sign: | N/A | | +| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `Error` | `*string` | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. A non-zero `exitCode` is a command failure, not a tool failure. | | +| `ExitCode` | `*int64` | :heavy_minus_sign: | N/A | | +| `Files` | [][components.OutputBashServerToolItemFile](../../models/components/outputbashservertoolitemfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Stderr` | `*string` | :heavy_minus_sign: | N/A | | +| `Stdout` | `*string` | :heavy_minus_sign: | N/A | | +| `Type` | [components.OutputBashServerToolItemTypeOpenrouterBash](../../models/components/outputbashservertoolitemtypeopenrouterbash.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputbashservertoolitemfile.mdx b/docs/models/components/outputbashservertoolitemfile.mdx index f114a0ef6..74172357e 100644 --- a/docs/models/components/outputbashservertoolitemfile.mdx +++ b/docs/models/components/outputbashservertoolitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputBashServerToolItemFile" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Type` | [components.OutputBashServerToolItemTypeContainerFileCitation](../../models/components/outputbashservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.OutputBashServerToolItemTypeContainerFileCitation](../../models/components/outputbashservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputbrowseruseservertoolitem.mdx b/docs/models/components/outputbrowseruseservertoolitem.mdx index 73b2a3cc0..25673e0fa 100644 --- a/docs/models/components/outputbrowseruseservertoolitem.mdx +++ b/docs/models/components/outputbrowseruseservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:browser_use server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Action` | `*string` | ➖ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `ScreenshotB64` | `*string` | ➖ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputBrowserUseServerToolItemType](../../models/components/outputbrowseruseservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Action` | `*string` | :heavy_minus_sign: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `ScreenshotB64` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputBrowserUseServerToolItemType](../../models/components/outputbrowseruseservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputcodeinterpretercallitem.mdx b/docs/models/components/outputcodeinterpretercallitem.mdx index 6ef851a52..58d04ea03 100644 --- a/docs/models/components/outputcodeinterpretercallitem.mdx +++ b/docs/models/components/outputcodeinterpretercallitem.mdx @@ -9,10 +9,10 @@ A code interpreter execution call with outputs | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Code` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ContainerID` | `*string` | ➖ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Outputs` | optionalnullable.OptionalNullable[[][components.OutputCodeInterpreterCallItemOutput](../../models/components/outputcodeinterpretercallitemoutput.mdx)] | ➖ | N/A | | -| `Status` | [components.OutputCodeInterpreterCallItemStatus](../../models/components/outputcodeinterpretercallitemstatus.mdx) | ✅ | N/A | | -| `Type` | [components.OutputCodeInterpreterCallItemType](../../models/components/outputcodeinterpretercallitemtype.mdx) | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file +| `Code` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ContainerID` | `*string` | :heavy_minus_sign: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Outputs` | optionalnullable.OptionalNullable[[][components.OutputCodeInterpreterCallItemOutput](../../models/components/outputcodeinterpretercallitemoutput.mdx)] | :heavy_minus_sign: | N/A | | +| `Status` | [components.OutputCodeInterpreterCallItemStatus](../../models/components/outputcodeinterpretercallitemstatus.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.OutputCodeInterpreterCallItemType](../../models/components/outputcodeinterpretercallitemtype.mdx) | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file diff --git a/docs/models/components/outputcodeinterpreterservertoolitem.mdx b/docs/models/components/outputcodeinterpreterservertoolitem.mdx index 1ca5247dc..43f758a57 100644 --- a/docs/models/components/outputcodeinterpreterservertoolitem.mdx +++ b/docs/models/components/outputcodeinterpreterservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:code_interpreter server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Code` | `*string` | ➖ | N/A | | -| `ExitCode` | `*int64` | ➖ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Language` | `*string` | ➖ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Stderr` | `*string` | ➖ | N/A | | -| `Stdout` | `*string` | ➖ | N/A | | -| `Type` | [components.OutputCodeInterpreterServerToolItemType](../../models/components/outputcodeinterpreterservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Code` | `*string` | :heavy_minus_sign: | N/A | | +| `ExitCode` | `*int64` | :heavy_minus_sign: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Language` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Stderr` | `*string` | :heavy_minus_sign: | N/A | | +| `Stdout` | `*string` | :heavy_minus_sign: | N/A | | +| `Type` | [components.OutputCodeInterpreterServerToolItemType](../../models/components/outputcodeinterpreterservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputcomputercallitem.mdx b/docs/models/components/outputcomputercallitem.mdx index c24b78165..f63420774 100644 --- a/docs/models/components/outputcomputercallitem.mdx +++ b/docs/models/components/outputcomputercallitem.mdx @@ -6,9 +6,9 @@ title: "OutputComputerCallItem" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Action` | `any` | ➖ | N/A | -| `CallID` | `string` | ✅ | N/A | -| `ID` | `*string` | ➖ | N/A | -| `PendingSafetyChecks` | [][components.PendingSafetyCheck](../../models/components/pendingsafetycheck.mdx) | ✅ | N/A | -| `Status` | [components.OutputComputerCallItemStatus](../../models/components/outputcomputercallitemstatus.mdx) | ✅ | N/A | -| `Type` | [components.OutputComputerCallItemType](../../models/components/outputcomputercallitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Action` | `any` | :heavy_minus_sign: | N/A | +| `CallID` | `string` | :heavy_check_mark: | N/A | +| `ID` | `*string` | :heavy_minus_sign: | N/A | +| `PendingSafetyChecks` | [][components.PendingSafetyCheck](../../models/components/pendingsafetycheck.mdx) | :heavy_check_mark: | N/A | +| `Status` | [components.OutputComputerCallItemStatus](../../models/components/outputcomputercallitemstatus.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.OutputComputerCallItemType](../../models/components/outputcomputercallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputcustomtoolcallitem.mdx b/docs/models/components/outputcustomtoolcallitem.mdx index 018f82a9f..c6672c38b 100644 --- a/docs/models/components/outputcustomtoolcallitem.mdx +++ b/docs/models/components/outputcustomtoolcallitem.mdx @@ -9,11 +9,11 @@ A call to a custom (freeform-grammar) tool created by the model — distinct fro | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Input` | `string` | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.OutputCustomToolCallItemStatus](../../models/components/outputcustomtoolcallitemstatus.mdx) | ➖ | N/A | | -| `Type` | [components.OutputCustomToolCallItemType](../../models/components/outputcustomtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Input` | `string` | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.OutputCustomToolCallItemStatus](../../models/components/outputcustomtoolcallitemstatus.mdx) | :heavy_minus_sign: | N/A | | +| `Type` | [components.OutputCustomToolCallItemType](../../models/components/outputcustomtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputdatetimeitem.mdx b/docs/models/components/outputdatetimeitem.mdx index bbe03919a..c6ee2019e 100644 --- a/docs/models/components/outputdatetimeitem.mdx +++ b/docs/models/components/outputdatetimeitem.mdx @@ -9,9 +9,9 @@ An openrouter:datetime server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Datetime` | `string` | ✅ | ISO 8601 datetime string | | -| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | ➖ | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Timezone` | `string` | ✅ | IANA timezone name | | -| `Type` | [components.OutputDatetimeItemType](../../models/components/outputdatetimeitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Datetime` | `string` | :heavy_check_mark: | ISO 8601 datetime string | | +| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Timezone` | `string` | :heavy_check_mark: | IANA timezone name | | +| `Type` | [components.OutputDatetimeItemType](../../models/components/outputdatetimeitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesearchcallitem.mdx b/docs/models/components/outputfilesearchcallitem.mdx index 038cf5977..7ec3d6c62 100644 --- a/docs/models/components/outputfilesearchcallitem.mdx +++ b/docs/models/components/outputfilesearchcallitem.mdx @@ -6,7 +6,7 @@ title: "OutputFileSearchCallItem" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | N/A | | -| `Queries` | []`string` | ✅ | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputFileSearchCallItemType](../../models/components/outputfilesearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Queries` | []`string` | :heavy_check_mark: | N/A | | +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputFileSearchCallItemType](../../models/components/outputfilesearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesearchservertoolitem.mdx b/docs/models/components/outputfilesearchservertoolitem.mdx index 891f28346..74dcebbee 100644 --- a/docs/models/components/outputfilesearchservertoolitem.mdx +++ b/docs/models/components/outputfilesearchservertoolitem.mdx @@ -9,7 +9,7 @@ An openrouter:file_search server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ID` | `*string` | ➖ | N/A | | -| `Queries` | []`string` | ➖ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputFileSearchServerToolItemType](../../models/components/outputfilesearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Queries` | []`string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputFileSearchServerToolItemType](../../models/components/outputfilesearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesservertoolitem.mdx b/docs/models/components/outputfilesservertoolitem.mdx index 7e33f0a35..e960931cb 100644 --- a/docs/models/components/outputfilesservertoolitem.mdx +++ b/docs/models/components/outputfilesservertoolitem.mdx @@ -9,13 +9,13 @@ An openrouter:files server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. | | -| `CallID` | optionalnullable.OptionalNullable[`string`] | ➖ | The model-generated tool call id from the originating turn. | | -| `Error` | `*string` | ➖ | Error message when the file operation failed. | | -| `FileID` | `*string` | ➖ | The target file id supplied in the tool-call arguments. | | -| `Filename` | `*string` | ➖ | The target filename supplied in the tool-call arguments. | | -| `ID` | `*string` | ➖ | N/A | | -| `Operation` | `*string` | ➖ | The file operation performed (list, read, write, or edit). | | -| `Result` | `*string` | ➖ | JSON-serialized result of the file operation. | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputFilesServerToolItemType](../../models/components/outputfilesservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | +| `CallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | +| `Error` | `*string` | :heavy_minus_sign: | Error message when the file operation failed. | | +| `FileID` | `*string` | :heavy_minus_sign: | The target file id supplied in the tool-call arguments. | | +| `Filename` | `*string` | :heavy_minus_sign: | The target filename supplied in the tool-call arguments. | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Operation` | `*string` | :heavy_minus_sign: | The file operation performed (list, read, write, or edit). | | +| `Result` | `*string` | :heavy_minus_sign: | JSON-serialized result of the file operation. | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputFilesServerToolItemType](../../models/components/outputfilesservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfunctioncallitem.mdx b/docs/models/components/outputfunctioncallitem.mdx index 3a42a9e54..a71c13427 100644 --- a/docs/models/components/outputfunctioncallitem.mdx +++ b/docs/models/components/outputfunctioncallitem.mdx @@ -6,13 +6,13 @@ title: "OutputFunctionCallItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | ✅ | N/A | | -| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.OutputFunctionCallItemStatusUnion](../../models/components/outputfunctioncallitemstatusunion.mdx) | ➖ | N/A | | -| `Type` | [components.OutputFunctionCallItemType](../../models/components/outputfunctioncallitemtype.mdx) | ✅ | N/A | | -| `SubagentID` | `*string` | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `SubagentItems` | [][components.OutputFunctionCallItemSubagentItem](../../models/components/outputfunctioncallitemsubagentitem.mdx) | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | | +| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.OutputFunctionCallItemStatusUnion](../../models/components/outputfunctioncallitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | +| `Type` | [components.OutputFunctionCallItemType](../../models/components/outputfunctioncallitemtype.mdx) | :heavy_check_mark: | N/A | | +| `SubagentID` | `*string` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `SubagentItems` | [][components.OutputFunctionCallItemSubagentItem](../../models/components/outputfunctioncallitemsubagentitem.mdx) | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | \ No newline at end of file diff --git a/docs/models/components/outputfunctioncallitemsubagentitem.mdx b/docs/models/components/outputfunctioncallitemsubagentitem.mdx index ea9104111..2f3773d6f 100644 --- a/docs/models/components/outputfunctioncallitemsubagentitem.mdx +++ b/docs/models/components/outputfunctioncallitemsubagentitem.mdx @@ -6,5 +6,5 @@ title: "OutputFunctionCallItemSubagentItem" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Type` | `string` | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputfusionservertoolitem.mdx b/docs/models/components/outputfusionservertoolitem.mdx index 43e7d9c82..5b48e67ff 100644 --- a/docs/models/components/outputfusionservertoolitem.mdx +++ b/docs/models/components/outputfusionservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:fusion server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Analysis` | [*components.FusionAnalysisResult](../../models/components/fusionanalysisresult.mdx) | ➖ | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | -| `Error` | `*string` | ➖ | Error message when the fusion run did not produce an analysis result. | | -| `FailedModels` | [][components.FailedModel](../../models/components/failedmodel.mdx) | ➖ | Models that were requested as part of the analysis panel but did not produce a response. Present when at least one requested analysis model failed. On a completed item the fusion result is still usable but was produced from a degraded panel; on a failed item it lists the panels that failed before the run stopped, so the caller can see which models were attempted even though no analysis was produced. | | -| `FailureReason` | `*string` | ➖ | Typed failure reason when the fusion run failed. Possible values include: all_panels_failed, insufficient_credits, rate_limited, invalid_model, judge_not_valid_json, judge_schema_mismatch, judge_upstream_error, judge_empty_completion. The four analysis-stage codes keep their pre-rename `judge_` spelling so existing consumers keep matching. The consumer-cancellation code is `cancelled`. | | -| `ID` | `*string` | ➖ | N/A | | -| `Responses` | [][components.OutputFusionServerToolItemResponse](../../models/components/outputfusionservertoolitemresponse.mdx) | ➖ | Analysis models that produced a response in this fusion run, with each model's full panel content. | | -| `Sources` | [][components.FusionSource](../../models/components/fusionsource.mdx) | ➖ | Web pages the analysis panels and analyst retrieved via web search during this fusion run, deduplicated by URL across the whole run. Present when at least one model cited a source. | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputFusionServerToolItemType](../../models/components/outputfusionservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Analysis` | [*components.FusionAnalysisResult](../../models/components/fusionanalysisresult.mdx) | :heavy_minus_sign: | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | +| `Error` | `*string` | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | +| `FailedModels` | [][components.FailedModel](../../models/components/failedmodel.mdx) | :heavy_minus_sign: | Models that were requested as part of the analysis panel but did not produce a response. Present when at least one requested analysis model failed. On a completed item the fusion result is still usable but was produced from a degraded panel; on a failed item it lists the panels that failed before the run stopped, so the caller can see which models were attempted even though no analysis was produced. | | +| `FailureReason` | `*string` | :heavy_minus_sign: | Typed failure reason when the fusion run failed. Possible values include: all_panels_failed, insufficient_credits, rate_limited, invalid_model, judge_not_valid_json, judge_schema_mismatch, judge_upstream_error, judge_empty_completion. The four analysis-stage codes keep their pre-rename `judge_` spelling so existing consumers keep matching. The consumer-cancellation code is `cancelled`. | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Responses` | [][components.OutputFusionServerToolItemResponse](../../models/components/outputfusionservertoolitemresponse.mdx) | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | +| `Sources` | [][components.FusionSource](../../models/components/fusionsource.mdx) | :heavy_minus_sign: | Web pages the analysis panels and analyst retrieved via web search during this fusion run, deduplicated by URL across the whole run. Present when at least one model cited a source. | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputFusionServerToolItemType](../../models/components/outputfusionservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfusionservertoolitemresponse.mdx b/docs/models/components/outputfusionservertoolitemresponse.mdx index fcf749faf..2c0dd46f2 100644 --- a/docs/models/components/outputfusionservertoolitemresponse.mdx +++ b/docs/models/components/outputfusionservertoolitemresponse.mdx @@ -6,5 +6,5 @@ title: "OutputFusionServerToolItemResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Content` | `*string` | ➖ | N/A | -| `Model` | `string` | ✅ | N/A | \ No newline at end of file +| `Content` | `*string` | :heavy_minus_sign: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputimagegenerationcallitem.mdx b/docs/models/components/outputimagegenerationcallitem.mdx index e981d59c9..9bd9a25d8 100644 --- a/docs/models/components/outputimagegenerationcallitem.mdx +++ b/docs/models/components/outputimagegenerationcallitem.mdx @@ -6,8 +6,8 @@ title: "OutputImageGenerationCallItem" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | ✅ | N/A | | -| `Result` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputImageGenerationCallItemType](../../models/components/outputimagegenerationcallitemtype.mdx) | ✅ | N/A | | -| `Prompt` | `*string` | ➖ | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputImageGenerationCallItemType](../../models/components/outputimagegenerationcallitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Prompt` | `*string` | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file diff --git a/docs/models/components/outputimagegenerationservertoolitem.mdx b/docs/models/components/outputimagegenerationservertoolitem.mdx index 954fded85..c6bb28069 100644 --- a/docs/models/components/outputimagegenerationservertoolitem.mdx +++ b/docs/models/components/outputimagegenerationservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:image_generation server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | ➖ | N/A | | -| `ImageB64` | `*string` | ➖ | N/A | | -| `ImageURL` | `*string` | ➖ | N/A | | -| `Prompt` | `*string` | ➖ | The prompt (possibly rewritten) that the image was generated from. | | -| `Result` | optionalnullable.OptionalNullable[`string`] | ➖ | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | -| `RevisedPrompt` | `*string` | ➖ | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputImageGenerationServerToolItemType](../../models/components/outputimagegenerationservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `ImageB64` | `*string` | :heavy_minus_sign: | N/A | | +| `ImageURL` | `*string` | :heavy_minus_sign: | N/A | | +| `Prompt` | `*string` | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | +| `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | +| `RevisedPrompt` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputImageGenerationServerToolItemType](../../models/components/outputimagegenerationservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemapplypatchcall.mdx b/docs/models/components/outputitemapplypatchcall.mdx index d5c69e9a7..4c62e74ca 100644 --- a/docs/models/components/outputitemapplypatchcall.mdx +++ b/docs/models/components/outputitemapplypatchcall.mdx @@ -6,9 +6,9 @@ title: "OutputItemApplyPatchCall" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `CallID` | `string` | ✅ | N/A | -| `CreatedBy` | `*string` | ➖ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Operation` | [components.Operation](../../models/components/operation.mdx) | ✅ | N/A | -| `Status` | [components.OutputItemApplyPatchCallStatus](../../models/components/outputitemapplypatchcallstatus.mdx) | ✅ | N/A | -| `Type` | [components.OutputItemApplyPatchCallType](../../models/components/outputitemapplypatchcalltype.mdx) | ✅ | N/A | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | +| `CreatedBy` | `*string` | :heavy_minus_sign: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Operation` | [components.Operation](../../models/components/operation.mdx) | :heavy_check_mark: | N/A | +| `Status` | [components.OutputItemApplyPatchCallStatus](../../models/components/outputitemapplypatchcallstatus.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.OutputItemApplyPatchCallType](../../models/components/outputitemapplypatchcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputitemcodeinterpretercall.mdx b/docs/models/components/outputitemcodeinterpretercall.mdx index cc95c98cd..de3d8dfae 100644 --- a/docs/models/components/outputitemcodeinterpretercall.mdx +++ b/docs/models/components/outputitemcodeinterpretercall.mdx @@ -6,10 +6,10 @@ title: "OutputItemCodeInterpreterCall" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Code` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ContainerID` | `*string` | ➖ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Outputs` | optionalnullable.OptionalNullable[[][components.OutputItemCodeInterpreterCallOutput](../../models/components/outputitemcodeinterpretercalloutput.mdx)] | ➖ | N/A | | -| `Status` | [components.OutputItemCodeInterpreterCallStatus](../../models/components/outputitemcodeinterpretercallstatus.mdx) | ✅ | N/A | | -| `Type` | [components.OutputItemCodeInterpreterCallType](../../models/components/outputitemcodeinterpretercalltype.mdx) | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"code": "print(\"hello\")",
"id": "ci_abc123",
"outputs": [
\{
"logs": "hello\n",
"type": "logs"
}
],
"status": "completed",
"type": "code_interpreter_call"
} | \ No newline at end of file +| `Code` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ContainerID` | `*string` | :heavy_minus_sign: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Outputs` | optionalnullable.OptionalNullable[[][components.OutputItemCodeInterpreterCallOutput](../../models/components/outputitemcodeinterpretercalloutput.mdx)] | :heavy_minus_sign: | N/A | | +| `Status` | [components.OutputItemCodeInterpreterCallStatus](../../models/components/outputitemcodeinterpretercallstatus.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.OutputItemCodeInterpreterCallType](../../models/components/outputitemcodeinterpretercalltype.mdx) | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"code": "print(\"hello\")",
"id": "ci_abc123",
"outputs": [
\{
"logs": "hello\n",
"type": "logs"
}
],
"status": "completed",
"type": "code_interpreter_call"
} | \ No newline at end of file diff --git a/docs/models/components/outputitemcustomtoolcall.mdx b/docs/models/components/outputitemcustomtoolcall.mdx index faa5250e8..d8aa4dc82 100644 --- a/docs/models/components/outputitemcustomtoolcall.mdx +++ b/docs/models/components/outputitemcustomtoolcall.mdx @@ -6,11 +6,11 @@ title: "OutputItemCustomToolCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Input` | `string` | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.OutputItemCustomToolCallStatus](../../models/components/outputitemcustomtoolcallstatus.mdx) | ➖ | N/A | | -| `Type` | [components.OutputItemCustomToolCallType](../../models/components/outputitemcustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Input` | `string` | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.OutputItemCustomToolCallStatus](../../models/components/outputitemcustomtoolcallstatus.mdx) | :heavy_minus_sign: | N/A | | +| `Type` | [components.OutputItemCustomToolCallType](../../models/components/outputitemcustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemfilesearchcall.mdx b/docs/models/components/outputitemfilesearchcall.mdx index 27056e4c2..6f0348b5c 100644 --- a/docs/models/components/outputitemfilesearchcall.mdx +++ b/docs/models/components/outputitemfilesearchcall.mdx @@ -6,7 +6,7 @@ title: "OutputItemFileSearchCall" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | N/A | | -| `Queries` | []`string` | ✅ | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputItemFileSearchCallType](../../models/components/outputitemfilesearchcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Queries` | []`string` | :heavy_check_mark: | N/A | | +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputItemFileSearchCallType](../../models/components/outputitemfilesearchcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemfunctioncall.mdx b/docs/models/components/outputitemfunctioncall.mdx index e90ac708e..fe943658a 100644 --- a/docs/models/components/outputitemfunctioncall.mdx +++ b/docs/models/components/outputitemfunctioncall.mdx @@ -6,11 +6,11 @@ title: "OutputItemFunctionCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Arguments` | `string` | ✅ | N/A | | -| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.OutputItemFunctionCallStatusUnion](../../models/components/outputitemfunctioncallstatusunion.mdx) | ➖ | N/A | | -| `Type` | [components.OutputItemFunctionCallType](../../models/components/outputitemfunctioncalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | | +| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.OutputItemFunctionCallStatusUnion](../../models/components/outputitemfunctioncallstatusunion.mdx) | :heavy_minus_sign: | N/A | | +| `Type` | [components.OutputItemFunctionCallType](../../models/components/outputitemfunctioncalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemimagegenerationcall.mdx b/docs/models/components/outputitemimagegenerationcall.mdx index 2785c635d..5f80bfc78 100644 --- a/docs/models/components/outputitemimagegenerationcall.mdx +++ b/docs/models/components/outputitemimagegenerationcall.mdx @@ -6,7 +6,7 @@ title: "OutputItemImageGenerationCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | ✅ | N/A | | -| `Result` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputItemImageGenerationCallType](../../models/components/outputitemimagegenerationcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputItemImageGenerationCallType](../../models/components/outputitemimagegenerationcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemreasoning.mdx b/docs/models/components/outputitemreasoning.mdx index f94ebdb64..73504d2cb 100644 --- a/docs/models/components/outputitemreasoning.mdx +++ b/docs/models/components/outputitemreasoning.mdx @@ -6,9 +6,9 @@ title: "OutputItemReasoning" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx) | ➖ | N/A | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Status` | [*components.OutputItemReasoningStatusUnion](../../models/components/outputitemreasoningstatusunion.mdx) | ➖ | N/A | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | -| `Type` | [components.OutputItemReasoningType](../../models/components/outputitemreasoningtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx) | :heavy_minus_sign: | N/A | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Status` | [*components.OutputItemReasoningStatusUnion](../../models/components/outputitemreasoningstatusunion.mdx) | :heavy_minus_sign: | N/A | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.OutputItemReasoningType](../../models/components/outputitemreasoningtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputitemwebsearchcall.mdx b/docs/models/components/outputitemwebsearchcall.mdx index 36745cf13..bd9471ba5 100644 --- a/docs/models/components/outputitemwebsearchcall.mdx +++ b/docs/models/components/outputitemwebsearchcall.mdx @@ -6,8 +6,8 @@ title: "OutputItemWebSearchCall" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputItemWebSearchCallActionUnion](../../models/components/outputitemwebsearchcallactionunion.mdx) | ➖ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputItemWebSearchCallTypeWebSearchCall](../../models/components/outputitemwebsearchcalltypewebsearchcall.mdx) | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"action": \{
"query": "OpenAI API",
"type": "search"
},
"id": "search-abc123",
"status": "completed",
"type": "web_search_call"
} | \ No newline at end of file +| `Action` | [*components.OutputItemWebSearchCallActionUnion](../../models/components/outputitemwebsearchcallactionunion.mdx) | :heavy_minus_sign: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputItemWebSearchCallTypeWebSearchCall](../../models/components/outputitemwebsearchcalltypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"action": \{
"query": "OpenAI API",
"type": "search"
},
"id": "search-abc123",
"status": "completed",
"type": "web_search_call"
} | \ No newline at end of file diff --git a/docs/models/components/outputitemwebsearchcallactionfindinpage.mdx b/docs/models/components/outputitemwebsearchcallactionfindinpage.mdx index baa51d90d..3e19a88b5 100644 --- a/docs/models/components/outputitemwebsearchcallactionfindinpage.mdx +++ b/docs/models/components/outputitemwebsearchcallactionfindinpage.mdx @@ -6,6 +6,6 @@ title: "OutputItemWebSearchCallActionFindInPage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Pattern` | `string` | ✅ | N/A | -| `Type` | [components.OutputItemWebSearchCallTypeFindInPage](../../models/components/outputitemwebsearchcalltypefindinpage.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Pattern` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.OutputItemWebSearchCallTypeFindInPage](../../models/components/outputitemwebsearchcalltypefindinpage.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputitemwebsearchcallactionopenpage.mdx b/docs/models/components/outputitemwebsearchcallactionopenpage.mdx index b83771bb9..c3cbcb821 100644 --- a/docs/models/components/outputitemwebsearchcallactionopenpage.mdx +++ b/docs/models/components/outputitemwebsearchcallactionopenpage.mdx @@ -6,5 +6,5 @@ title: "OutputItemWebSearchCallActionOpenPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OutputItemWebSearchCallTypeOpenPage](../../models/components/outputitemwebsearchcalltypeopenpage.mdx) | ✅ | N/A | -| `URL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file +| `Type` | [components.OutputItemWebSearchCallTypeOpenPage](../../models/components/outputitemwebsearchcalltypeopenpage.mdx) | :heavy_check_mark: | N/A | +| `URL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputitemwebsearchcallactionsearch.mdx b/docs/models/components/outputitemwebsearchcallactionsearch.mdx index 69952e2aa..85374ce0f 100644 --- a/docs/models/components/outputitemwebsearchcallactionsearch.mdx +++ b/docs/models/components/outputitemwebsearchcallactionsearch.mdx @@ -6,7 +6,7 @@ title: "OutputItemWebSearchCallActionSearch" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Queries` | []`string` | ➖ | N/A | -| `Query` | `string` | ✅ | N/A | -| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | ➖ | N/A | -| `Type` | [components.OutputItemWebSearchCallTypeSearch](../../models/components/outputitemwebsearchcalltypesearch.mdx) | ✅ | N/A | \ No newline at end of file +| `Queries` | []`string` | :heavy_minus_sign: | N/A | +| `Query` | `string` | :heavy_check_mark: | N/A | +| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputItemWebSearchCallTypeSearch](../../models/components/outputitemwebsearchcalltypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputmcpservertoolitem.mdx b/docs/models/components/outputmcpservertoolitem.mdx index 2277b8c4a..bc7aa85c9 100644 --- a/docs/models/components/outputmcpservertoolitem.mdx +++ b/docs/models/components/outputmcpservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:mcp server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ID` | `*string` | ➖ | N/A | | -| `ServerLabel` | `*string` | ➖ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `ToolName` | `*string` | ➖ | N/A | | -| `Type` | [components.OutputMcpServerToolItemType](../../models/components/outputmcpservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `ServerLabel` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `ToolName` | `*string` | :heavy_minus_sign: | N/A | | +| `Type` | [components.OutputMcpServerToolItemType](../../models/components/outputmcpservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputmemoryservertoolitem.mdx b/docs/models/components/outputmemoryservertoolitem.mdx index 29479ffee..09b7e5ec3 100644 --- a/docs/models/components/outputmemoryservertoolitem.mdx +++ b/docs/models/components/outputmemoryservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:memory server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Action` | [*components.ActionEnum](../../models/components/actionenum.mdx) | ➖ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Key` | `*string` | ➖ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputMemoryServerToolItemType](../../models/components/outputmemoryservertoolitemtype.mdx) | ✅ | N/A | | -| `Value` | `any` | ➖ | N/A | | \ No newline at end of file +| `Action` | [*components.ActionEnum](../../models/components/actionenum.mdx) | :heavy_minus_sign: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Key` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputMemoryServerToolItemType](../../models/components/outputmemoryservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Value` | `any` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputmessage.mdx b/docs/models/components/outputmessage.mdx index 72eb97e11..ce33cc76d 100644 --- a/docs/models/components/outputmessage.mdx +++ b/docs/models/components/outputmessage.mdx @@ -6,9 +6,9 @@ title: "OutputMessage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.OutputMessageContent](../../models/components/outputmessagecontent.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessagePhaseUnion](../../models/components/outputmessagephaseunion.mdx)] | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.OutputMessageRole](../../models/components/outputmessagerole.mdx) | ✅ | N/A | -| `Status` | [*components.OutputMessageStatusUnion](../../models/components/outputmessagestatusunion.mdx) | ➖ | N/A | -| `Type` | [components.OutputMessageType](../../models/components/outputmessagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [][components.OutputMessageContent](../../models/components/outputmessagecontent.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessagePhaseUnion](../../models/components/outputmessagephaseunion.mdx)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `Role` | [components.OutputMessageRole](../../models/components/outputmessagerole.mdx) | :heavy_check_mark: | N/A | +| `Status` | [*components.OutputMessageStatusUnion](../../models/components/outputmessagestatusunion.mdx) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputMessageType](../../models/components/outputmessagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputmessageitem.mdx b/docs/models/components/outputmessageitem.mdx index 7c79b802a..4a1ee6034 100644 --- a/docs/models/components/outputmessageitem.mdx +++ b/docs/models/components/outputmessageitem.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.OutputMessageItemContent](../../models/components/outputmessageitemcontent.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessageItemPhaseUnion](../../models/components/outputmessageitemphaseunion.mdx)] | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.OutputMessageItemRole](../../models/components/outputmessageitemrole.mdx) | ✅ | N/A | -| `Status` | [*components.OutputMessageItemStatusUnion](../../models/components/outputmessageitemstatusunion.mdx) | ➖ | N/A | -| `Type` | [components.OutputMessageItemType](../../models/components/outputmessageitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [][components.OutputMessageItemContent](../../models/components/outputmessageitemcontent.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessageItemPhaseUnion](../../models/components/outputmessageitemphaseunion.mdx)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `Role` | [components.OutputMessageItemRole](../../models/components/outputmessageitemrole.mdx) | :heavy_check_mark: | N/A | +| `Status` | [*components.OutputMessageItemStatusUnion](../../models/components/outputmessageitemstatusunion.mdx) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputMessageItemType](../../models/components/outputmessageitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputreasoningitem.mdx b/docs/models/components/outputreasoningitem.mdx index be15ec38a..05843b636 100644 --- a/docs/models/components/outputreasoningitem.mdx +++ b/docs/models/components/outputreasoningitem.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | ➖ | N/A | | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Status` | [*components.OutputReasoningItemStatusUnion](../../models/components/outputreasoningitemstatusunion.mdx) | ➖ | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | | -| `Type` | [components.OutputReasoningItemType](../../models/components/outputreasoningitemtype.mdx) | ✅ | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | -| `Signature` | optionalnullable.OptionalNullable[`string`] | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [*components.OutputReasoningItemStatusUnion](../../models/components/outputreasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.OutputReasoningItemType](../../models/components/outputreasoningitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/components/outputsearchmodelsservertoolitem.mdx b/docs/models/components/outputsearchmodelsservertoolitem.mdx index d44b7b225..79a6ac995 100644 --- a/docs/models/components/outputsearchmodelsservertoolitem.mdx +++ b/docs/models/components/outputsearchmodelsservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:experimental__search_models server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `*string` | ➖ | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | -| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | ➖ | N/A | | -| `Query` | `*string` | ➖ | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputSearchModelsServerToolItemType](../../models/components/outputsearchmodelsservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | `*string` | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | +| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Query` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputSearchModelsServerToolItemType](../../models/components/outputsearchmodelsservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcallitem.mdx b/docs/models/components/outputshellcallitem.mdx index ce3cfdff2..e29cfed42 100644 --- a/docs/models/components/outputshellcallitem.mdx +++ b/docs/models/components/outputshellcallitem.mdx @@ -9,9 +9,9 @@ A native `shell_call` output item matching OpenAI's Responses API shape. Emitted | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputShellCallItemAction](../../models/components/outputshellcallitemaction.mdx) | ➖ | N/A | | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | -| `CallID` | `string` | ✅ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | -| `Type` | [components.OutputShellCallItemType](../../models/components/outputshellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Action` | [*components.OutputShellCallItemAction](../../models/components/outputshellcallitemaction.mdx) | :heavy_minus_sign: | N/A | | +| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | +| `Type` | [components.OutputShellCallItemType](../../models/components/outputshellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcallitemaction.mdx b/docs/models/components/outputshellcallitemaction.mdx index 37540134c..c841bd3e5 100644 --- a/docs/models/components/outputshellcallitemaction.mdx +++ b/docs/models/components/outputshellcallitemaction.mdx @@ -6,6 +6,6 @@ title: "OutputShellCallItemAction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Commands` | []`string` | ✅ | N/A | -| `MaxOutputLength` | `*int64` | ✅ | N/A | -| `TimeoutMs` | `*int64` | ✅ | N/A | \ No newline at end of file +| `Commands` | []`string` | :heavy_check_mark: | N/A | +| `MaxOutputLength` | `*int64` | :heavy_check_mark: | N/A | +| `TimeoutMs` | `*int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputshellcalloutputitem.mdx b/docs/models/components/outputshellcalloutputitem.mdx index 5a4b9fd05..09ef848d1 100644 --- a/docs/models/components/outputshellcalloutputitem.mdx +++ b/docs/models/components/outputshellcalloutputitem.mdx @@ -9,12 +9,12 @@ A native `shell_call_output` item matching OpenAI's Responses API shape. Carries | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | ✅ | N/A | | -| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `Error` | `*string` | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'incomplete'` and an empty `output`; absent on a successful call. | | -| `Files` | [][components.OutputShellCallOutputItemFile](../../models/components/outputshellcalloutputitemfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `ID` | `string` | ✅ | N/A | | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | -| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | ✅ | N/A | | -| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | -| `Type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../../models/components/outputshellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `Error` | `*string` | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'incomplete'` and an empty `output`; absent on a successful call. | | +| `Files` | [][components.OutputShellCallOutputItemFile](../../models/components/outputshellcalloutputitemfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | +| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | :heavy_check_mark: | N/A | | +| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | +| `Type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../../models/components/outputshellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcalloutputitemfile.mdx b/docs/models/components/outputshellcalloutputitemfile.mdx index c5858b81b..85ccb9970 100644 --- a/docs/models/components/outputshellcalloutputitemfile.mdx +++ b/docs/models/components/outputshellcalloutputitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputShellCallOutputItemFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Type` | [components.OutputShellCallOutputItemTypeContainerFileCitation](../../models/components/outputshellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.OutputShellCallOutputItemTypeContainerFileCitation](../../models/components/outputshellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputshellservertoolitem.mdx b/docs/models/components/outputshellservertoolitem.mdx index a5a626072..1723c5f78 100644 --- a/docs/models/components/outputshellservertoolitem.mdx +++ b/docs/models/components/outputshellservertoolitem.mdx @@ -9,13 +9,13 @@ An openrouter:shell server tool output item | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputShellServerToolItemAction](../../models/components/outputshellservertoolitemaction.mdx) | ➖ | N/A | | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. | | -| `CallID` | optionalnullable.OptionalNullable[`string`] | ➖ | The model-generated tool call id from the originating turn. | | -| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `Error` | `*string` | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. `output` is omitted when `error` is set. | | -| `Files` | [][components.OutputShellServerToolItemFile](../../models/components/outputshellservertoolitemfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `ID` | `*string` | ➖ | N/A | | -| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | ➖ | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputShellServerToolItemTypeOpenrouterShell](../../models/components/outputshellservertoolitemtypeopenroutershell.mdx) | ✅ | N/A | | \ No newline at end of file +| `Action` | [*components.OutputShellServerToolItemAction](../../models/components/outputshellservertoolitemaction.mdx) | :heavy_minus_sign: | N/A | | +| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | +| `CallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | +| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `Error` | `*string` | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. `output` is omitted when `error` is set. | | +| `Files` | [][components.OutputShellServerToolItemFile](../../models/components/outputshellservertoolitemfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | :heavy_minus_sign: | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputShellServerToolItemTypeOpenrouterShell](../../models/components/outputshellservertoolitemtypeopenroutershell.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellservertoolitemaction.mdx b/docs/models/components/outputshellservertoolitemaction.mdx index 9030fc37a..2e748d553 100644 --- a/docs/models/components/outputshellservertoolitemaction.mdx +++ b/docs/models/components/outputshellservertoolitemaction.mdx @@ -6,6 +6,6 @@ title: "OutputShellServerToolItemAction" | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `Commands` | []`string` | ✅ | N/A | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | -| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | \ No newline at end of file +| `Commands` | []`string` | :heavy_check_mark: | N/A | +| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | +| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputshellservertoolitemfile.mdx b/docs/models/components/outputshellservertoolitemfile.mdx index c3bbf58ca..a5dbf3cea 100644 --- a/docs/models/components/outputshellservertoolitemfile.mdx +++ b/docs/models/components/outputshellservertoolitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputShellServerToolItemFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Type` | [components.OutputShellServerToolItemTypeContainerFileCitation](../../models/components/outputshellservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.OutputShellServerToolItemTypeContainerFileCitation](../../models/components/outputshellservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputsubagentservertoolitem.mdx b/docs/models/components/outputsubagentservertoolitem.mdx index cac1dcde3..246183b42 100644 --- a/docs/models/components/outputsubagentservertoolitem.mdx +++ b/docs/models/components/outputsubagentservertoolitem.mdx @@ -9,14 +9,14 @@ An openrouter:subagent server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `*string` | ➖ | EXPERIMENTAL — subject to change without notice. The `call_id` of the tool call that spawned this subagent. This id will also be included as the `subagent_id` on any `function_call` items created by the subagent. This must be returned in the request so the `function_call` can be matched with the correct subagent. A suspended `in_progress` item is announced once and never re-emitted or terminally closed — completion arrives as a new item with the same `call_id`. | | -| `Error` | `*string` | ➖ | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | -| `ID` | `*string` | ➖ | N/A | | -| `InstanceName` | `*string` | ➖ | Provider-safe function name of the specific subagent instance that produced this item (e.g. `openrouter_subagent__1`). Present only on items from non-default instances — the second and later subagent entries in the request `tools` array. The first (default) instance omits it, even when multiple subagents are configured. When a replayed item echoes this field back, the transcript rehydrates the call under that instance's tool. This identity is positional: it is derived from the index of the subagent entry in the request `tools` array, so keep the order of subagent entries stable across requests in a conversation. | openrouter_subagent__1 | -| `Model` | `*string` | ➖ | Slug of the worker model that executed the task. | | -| `Name` | `*string` | ➖ | Configured name of the subagent that executed the task (the `name` on its tool entry). Present only for named subagents; omitted for an unnamed (default) subagent. | summarizer | -| `Outcome` | `*string` | ➖ | The worker model's result (the outcome text returned to the delegating model). | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `TaskDescription` | `*string` | ➖ | The task description the delegating model sent to the worker. | | -| `TaskName` | `*string` | ➖ | The short task identifier the delegating model supplied. | | -| `Type` | [components.OutputSubagentServerToolItemType](../../models/components/outputsubagentservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `CallID` | `*string` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The `call_id` of the tool call that spawned this subagent. This id will also be included as the `subagent_id` on any `function_call` items created by the subagent. This must be returned in the request so the `function_call` can be matched with the correct subagent. A suspended `in_progress` item is announced once and never re-emitted or terminally closed — completion arrives as a new item with the same `call_id`. | | +| `Error` | `*string` | :heavy_minus_sign: | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `InstanceName` | `*string` | :heavy_minus_sign: | Provider-safe function name of the specific subagent instance that produced this item (e.g. `openrouter_subagent__1`). Present only on items from non-default instances — the second and later subagent entries in the request `tools` array. The first (default) instance omits it, even when multiple subagents are configured. When a replayed item echoes this field back, the transcript rehydrates the call under that instance's tool. This identity is positional: it is derived from the index of the subagent entry in the request `tools` array, so keep the order of subagent entries stable across requests in a conversation. | openrouter_subagent__1 | +| `Model` | `*string` | :heavy_minus_sign: | Slug of the worker model that executed the task. | | +| `Name` | `*string` | :heavy_minus_sign: | Configured name of the subagent that executed the task (the `name` on its tool entry). Present only for named subagents; omitted for an unnamed (default) subagent. | summarizer | +| `Outcome` | `*string` | :heavy_minus_sign: | The worker model's result (the outcome text returned to the delegating model). | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `TaskDescription` | `*string` | :heavy_minus_sign: | The task description the delegating model sent to the worker. | | +| `TaskName` | `*string` | :heavy_minus_sign: | The short task identifier the delegating model supplied. | | +| `Type` | [components.OutputSubagentServerToolItemType](../../models/components/outputsubagentservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputtexteditorservertoolitem.mdx b/docs/models/components/outputtexteditorservertoolitem.mdx index 05e82f1cb..039f5e00c 100644 --- a/docs/models/components/outputtexteditorservertoolitem.mdx +++ b/docs/models/components/outputtexteditorservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:text_editor server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Command` | [*components.Command](../../models/components/command.mdx) | ➖ | N/A | | -| `FilePath` | `*string` | ➖ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputTextEditorServerToolItemType](../../models/components/outputtexteditorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Command` | [*components.Command](../../models/components/command.mdx) | :heavy_minus_sign: | N/A | | +| `FilePath` | `*string` | :heavy_minus_sign: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputTextEditorServerToolItemType](../../models/components/outputtexteditorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputtokensdetails.mdx b/docs/models/components/outputtokensdetails.mdx index f5e57d954..e4615eaa0 100644 --- a/docs/models/components/outputtokensdetails.mdx +++ b/docs/models/components/outputtokensdetails.mdx @@ -6,4 +6,4 @@ title: "OutputTokensDetails" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ReasoningTokens` | `int64` | ✅ | N/A | \ No newline at end of file +| `ReasoningTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputtoolsearchcallitem.mdx b/docs/models/components/outputtoolsearchcallitem.mdx index ebabd4695..8d32cfdbf 100644 --- a/docs/models/components/outputtoolsearchcallitem.mdx +++ b/docs/models/components/outputtoolsearchcallitem.mdx @@ -9,9 +9,9 @@ A call the model made to a `tool_search` tool declared with `"execution": "clien | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Arguments` | `any` | ➖ | N/A | | -| `CallID` | `string` | ✅ | N/A | | -| `Execution` | [components.OutputToolSearchCallItemExecution](../../models/components/outputtoolsearchcallitemexecution.mdx) | ✅ | N/A | | -| `ID` | `*string` | ➖ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputToolSearchCallItemType](../../models/components/outputtoolsearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | `any` | :heavy_minus_sign: | N/A | | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `Execution` | [components.OutputToolSearchCallItemExecution](../../models/components/outputtoolsearchcallitemexecution.mdx) | :heavy_check_mark: | N/A | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputToolSearchCallItemType](../../models/components/outputtoolsearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputtoolsearchservertoolitem.mdx b/docs/models/components/outputtoolsearchservertoolitem.mdx index 6d32b0022..c666221ff 100644 --- a/docs/models/components/outputtoolsearchservertoolitem.mdx +++ b/docs/models/components/outputtoolsearchservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:tool_search server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | ➖ | N/A | | -| `Query` | `*string` | ➖ | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputToolSearchServerToolItemType](../../models/components/outputtoolsearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Query` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputToolSearchServerToolItemType](../../models/components/outputtoolsearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebfetchservertoolitem.mdx b/docs/models/components/outputwebfetchservertoolitem.mdx index fe48ddb91..181609b0f 100644 --- a/docs/models/components/outputwebfetchservertoolitem.mdx +++ b/docs/models/components/outputwebfetchservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:web_fetch server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Content` | `*string` | ➖ | N/A | | -| `Error` | `*string` | ➖ | The error message if the fetch failed. | | -| `HTTPStatus` | `*int64` | ➖ | The HTTP status code returned by the upstream URL fetch. | | -| `ID` | `*string` | ➖ | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | -| `Title` | `*string` | ➖ | N/A | | -| `Type` | [components.OutputWebFetchServerToolItemType](../../models/components/outputwebfetchservertoolitemtype.mdx) | ✅ | N/A | | -| `URL` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Content` | `*string` | :heavy_minus_sign: | N/A | | +| `Error` | `*string` | :heavy_minus_sign: | The error message if the fetch failed. | | +| `HTTPStatus` | `*int64` | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Title` | `*string` | :heavy_minus_sign: | N/A | | +| `Type` | [components.OutputWebFetchServerToolItemType](../../models/components/outputwebfetchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | +| `URL` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitem.mdx b/docs/models/components/outputwebsearchcallitem.mdx index 3ea3d4d75..45f40bec8 100644 --- a/docs/models/components/outputwebsearchcallitem.mdx +++ b/docs/models/components/outputwebsearchcallitem.mdx @@ -6,8 +6,8 @@ title: "OutputWebSearchCallItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputWebSearchCallItemActionUnion](../../models/components/outputwebsearchcallitemactionunion.mdx) | ➖ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputWebSearchCallItemTypeWebSearchCall](../../models/components/outputwebsearchcallitemtypewebsearchcall.mdx) | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file +| `Action` | [*components.OutputWebSearchCallItemActionUnion](../../models/components/outputwebsearchcallitemactionunion.mdx) | :heavy_minus_sign: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputWebSearchCallItemTypeWebSearchCall](../../models/components/outputwebsearchcallitemtypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitemactionfindinpage.mdx b/docs/models/components/outputwebsearchcallitemactionfindinpage.mdx index bcce8f459..d847dda95 100644 --- a/docs/models/components/outputwebsearchcallitemactionfindinpage.mdx +++ b/docs/models/components/outputwebsearchcallitemactionfindinpage.mdx @@ -6,6 +6,6 @@ title: "OutputWebSearchCallItemActionFindInPage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Pattern` | `string` | ✅ | N/A | -| `Type` | [components.OutputWebSearchCallItemTypeFindInPage](../../models/components/outputwebsearchcallitemtypefindinpage.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Pattern` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.OutputWebSearchCallItemTypeFindInPage](../../models/components/outputwebsearchcallitemtypefindinpage.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitemactionopenpage.mdx b/docs/models/components/outputwebsearchcallitemactionopenpage.mdx index 498b51277..b2df0abc8 100644 --- a/docs/models/components/outputwebsearchcallitemactionopenpage.mdx +++ b/docs/models/components/outputwebsearchcallitemactionopenpage.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchCallItemActionOpenPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OutputWebSearchCallItemTypeOpenPage](../../models/components/outputwebsearchcallitemtypeopenpage.mdx) | ✅ | N/A | -| `URL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file +| `Type` | [components.OutputWebSearchCallItemTypeOpenPage](../../models/components/outputwebsearchcallitemtypeopenpage.mdx) | :heavy_check_mark: | N/A | +| `URL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitemactionsearch.mdx b/docs/models/components/outputwebsearchcallitemactionsearch.mdx index fbe298d4f..d0edcd035 100644 --- a/docs/models/components/outputwebsearchcallitemactionsearch.mdx +++ b/docs/models/components/outputwebsearchcallitemactionsearch.mdx @@ -6,7 +6,7 @@ title: "OutputWebSearchCallItemActionSearch" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Queries` | []`string` | ➖ | N/A | -| `Query` | `string` | ✅ | N/A | -| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | ➖ | N/A | -| `Type` | [components.OutputWebSearchCallItemTypeSearch](../../models/components/outputwebsearchcallitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file +| `Queries` | []`string` | :heavy_minus_sign: | N/A | +| `Query` | `string` | :heavy_check_mark: | N/A | +| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputWebSearchCallItemTypeSearch](../../models/components/outputwebsearchcallitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitem.mdx b/docs/models/components/outputwebsearchservertoolitem.mdx index 06429a4bd..7b95e9e45 100644 --- a/docs/models/components/outputwebsearchservertoolitem.mdx +++ b/docs/models/components/outputwebsearchservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:web_search server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Action` | [*components.OutputWebSearchServerToolItemAction](../../models/components/outputwebsearchservertoolitemaction.mdx) | ➖ | The search action performed, matching OpenAI web_search_call.action shape. Includes the query the model issued and optional source URLs returned by the search provider. | | -| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | ➖ | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | -| `Type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../../models/components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | ✅ | N/A | | \ No newline at end of file +| `Action` | [*components.OutputWebSearchServerToolItemAction](../../models/components/outputwebsearchservertoolitemaction.mdx) | :heavy_minus_sign: | The search action performed, matching OpenAI web_search_call.action shape. Includes the query the model issued and optional source URLs returned by the search provider. | | +| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | :heavy_minus_sign: | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../../models/components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitemaction.mdx b/docs/models/components/outputwebsearchservertoolitemaction.mdx index e76b2d6ed..f48fb201d 100644 --- a/docs/models/components/outputwebsearchservertoolitemaction.mdx +++ b/docs/models/components/outputwebsearchservertoolitemaction.mdx @@ -9,6 +9,6 @@ The search action performed, matching OpenAI web_search_call.action shape. Inclu | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Query` | `string` | ✅ | N/A | -| `Sources` | [][components.OutputWebSearchServerToolItemSource](../../models/components/outputwebsearchservertoolitemsource.mdx) | ➖ | N/A | -| `Type` | [components.OutputWebSearchServerToolItemTypeSearch](../../models/components/outputwebsearchservertoolitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file +| `Query` | `string` | :heavy_check_mark: | N/A | +| `Sources` | [][components.OutputWebSearchServerToolItemSource](../../models/components/outputwebsearchservertoolitemsource.mdx) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputWebSearchServerToolItemTypeSearch](../../models/components/outputwebsearchservertoolitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitemsource.mdx b/docs/models/components/outputwebsearchservertoolitemsource.mdx index b8f6856f5..a674d64af 100644 --- a/docs/models/components/outputwebsearchservertoolitemsource.mdx +++ b/docs/models/components/outputwebsearchservertoolitemsource.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchServerToolItemSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.OutputWebSearchServerToolItemTypeURL](../../models/components/outputwebsearchservertoolitemtypeurl.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.OutputWebSearchServerToolItemTypeURL](../../models/components/outputwebsearchservertoolitemtypeurl.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/paretorouterplugin.mdx b/docs/models/components/paretorouterplugin.mdx index ba2ebc22b..c499f4b7b 100644 --- a/docs/models/components/paretorouterplugin.mdx +++ b/docs/models/components/paretorouterplugin.mdx @@ -6,8 +6,8 @@ title: "ParetoRouterPlugin" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | ➖ | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | -| `ID` | [components.ParetoRouterPluginID](../../models/components/paretorouterpluginid.mdx) | ✅ | N/A | | -| `MaxPrice` | `*float64` | ➖ | Maximum input price in USD per million tokens. When set, quality-tier selection (min_coding_score) is bypassed: the router computes the Pareto frontier over the top coding models and routes to the best-scoring frontier model priced at or below this cap, falling back through cheaper frontier models, then non-frontier models. Enforced against the price source given by price_source. Returns 404 when no candidate satisfies the cap. | 5 | -| `MinCodingScore` | `*float64` | ➖ | Minimum coding quality score between 0 and 1. Maps to internal quality tiers: >= 0.66 → high (top coding models), >= 0.33 → medium (strong modern flagships), < 0.33 → low (capable coders above the median). Omit to default to the highest tier (equivalent to >= 0.66). Not used when max_price is set (price-based selection takes over). | 0.8 | -| `PriceSource` | [*components.PriceSource](../../models/components/pricesource.mdx) | ➖ | Price source for the Pareto frontier cost axis and for enforcing max_price. "prompt" uses catalog list price (endpoint.pricing.prompt). "weighted_avg" uses traffic-weighted effective input price from ClickHouse, falling back to prompt price for models without traffic data. Defaults to "prompt". | | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | +| `ID` | [components.ParetoRouterPluginID](../../models/components/paretorouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `MaxPrice` | `*float64` | :heavy_minus_sign: | Maximum input price in USD per million tokens. When set, quality-tier selection (min_coding_score) is bypassed: the router computes the Pareto frontier over the top coding models and routes to the best-scoring frontier model priced at or below this cap, falling back through cheaper frontier models, then non-frontier models. Enforced against the price source given by price_source. Returns 404 when no candidate satisfies the cap. | 5 | +| `MinCodingScore` | `*float64` | :heavy_minus_sign: | Minimum coding quality score between 0 and 1. Maps to internal quality tiers: >= 0.66 → high (top coding models), >= 0.33 → medium (strong modern flagships), < 0.33 → low (capable coders above the median). Omit to default to the highest tier (equivalent to >= 0.66). Not used when max_price is set (price-based selection takes over). | 0.8 | +| `PriceSource` | [*components.PriceSource](../../models/components/pricesource.mdx) | :heavy_minus_sign: | Price source for the Pareto frontier cost axis and for enforcing max_price. "prompt" uses catalog list price (endpoint.pricing.prompt). "weighted_avg" uses traffic-weighted effective input price from ClickHouse, falling back to prompt price for models without traffic data. Defaults to "prompt". | | \ No newline at end of file diff --git a/docs/models/components/partialcoverage.mdx b/docs/models/components/partialcoverage.mdx index 695c78498..2a5e8dd1e 100644 --- a/docs/models/components/partialcoverage.mdx +++ b/docs/models/components/partialcoverage.mdx @@ -6,5 +6,5 @@ title: "PartialCoverage" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Models` | []`string` | ✅ | N/A | -| `Point` | `string` | ✅ | N/A | \ No newline at end of file +| `Models` | []`string` | :heavy_check_mark: | N/A | +| `Point` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/payloadtoolargeresponseerrordata.mdx b/docs/models/components/payloadtoolargeresponseerrordata.mdx index 423377083..fabd4a759 100644 --- a/docs/models/components/payloadtoolargeresponseerrordata.mdx +++ b/docs/models/components/payloadtoolargeresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for PayloadTooLargeResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/paymentrequiredresponseerrordata.mdx b/docs/models/components/paymentrequiredresponseerrordata.mdx index 67068fcca..a33c49cc2 100644 --- a/docs/models/components/paymentrequiredresponseerrordata.mdx +++ b/docs/models/components/paymentrequiredresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for PaymentRequiredResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/pdfparseroptions.mdx b/docs/models/components/pdfparseroptions.mdx index 9ee8419fd..7065b065a 100644 --- a/docs/models/components/pdfparseroptions.mdx +++ b/docs/models/components/pdfparseroptions.mdx @@ -9,4 +9,4 @@ Options for PDF parsing. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.PDFParserEngine](../../models/components/pdfparserengine.mdx) | ➖ | The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". | cloudflare-ai | \ No newline at end of file +| `Engine` | [*components.PDFParserEngine](../../models/components/pdfparserengine.mdx) | :heavy_minus_sign: | The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". | cloudflare-ai | \ No newline at end of file diff --git a/docs/models/components/pendingsafetycheck.mdx b/docs/models/components/pendingsafetycheck.mdx index ab6afff22..6a4fd63bd 100644 --- a/docs/models/components/pendingsafetycheck.mdx +++ b/docs/models/components/pendingsafetycheck.mdx @@ -6,6 +6,6 @@ title: "PendingSafetyCheck" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | \ No newline at end of file +| `Code` | `string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/percentilelatencycutoffs.mdx b/docs/models/components/percentilelatencycutoffs.mdx index fd0e6ba5e..7cc5dae79 100644 --- a/docs/models/components/percentilelatencycutoffs.mdx +++ b/docs/models/components/percentilelatencycutoffs.mdx @@ -9,7 +9,7 @@ Percentile-based latency cutoffs. All specified cutoffs must be met for an endpo | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `P50` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum p50 latency (seconds) | -| `P75` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum p75 latency (seconds) | -| `P90` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum p90 latency (seconds) | -| `P99` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum p99 latency (seconds) | \ No newline at end of file +| `P50` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p50 latency (seconds) | +| `P75` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p75 latency (seconds) | +| `P90` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p90 latency (seconds) | +| `P99` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/docs/models/components/percentilestats.mdx b/docs/models/components/percentilestats.mdx index 56f6fdf53..6aabafaa0 100644 --- a/docs/models/components/percentilestats.mdx +++ b/docs/models/components/percentilestats.mdx @@ -9,7 +9,7 @@ Latency percentiles in milliseconds over the last 30 minutes. Latency measures t | Field | Type | Required | Description | Example | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `P50` | `float64` | ✅ | Median (50th percentile) | 25.5 | -| `P75` | `float64` | ✅ | 75th percentile | 35.2 | -| `P90` | `float64` | ✅ | 90th percentile | 48.7 | -| `P99` | `float64` | ✅ | 99th percentile | 85.3 | \ No newline at end of file +| `P50` | `float64` | :heavy_check_mark: | Median (50th percentile) | 25.5 | +| `P75` | `float64` | :heavy_check_mark: | 75th percentile | 35.2 | +| `P90` | `float64` | :heavy_check_mark: | 90th percentile | 48.7 | +| `P99` | `float64` | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file diff --git a/docs/models/components/percentilethroughputcutoffs.mdx b/docs/models/components/percentilethroughputcutoffs.mdx index 7a536ff3c..b149d4fa3 100644 --- a/docs/models/components/percentilethroughputcutoffs.mdx +++ b/docs/models/components/percentilethroughputcutoffs.mdx @@ -9,7 +9,7 @@ Percentile-based throughput cutoffs. All specified cutoffs must be met for an en | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `P50` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum p50 throughput (tokens/sec) | -| `P75` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum p75 throughput (tokens/sec) | -| `P90` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum p90 throughput (tokens/sec) | -| `P99` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum p99 throughput (tokens/sec) | \ No newline at end of file +| `P50` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | +| `P75` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | +| `P90` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | +| `P99` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/docs/models/components/perflast30mbyworkload.mdx b/docs/models/components/perflast30mbyworkload.mdx index 318aa1803..dde50725f 100644 --- a/docs/models/components/perflast30mbyworkload.mdx +++ b/docs/models/components/perflast30mbyworkload.mdx @@ -9,12 +9,12 @@ Endpoint performance over the last 30 minutes, keyed by the kind of request serv | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Decisions` | [*components.Decisions](../../models/components/decisions.mdx) | ➖ | N/A | -| `Embeddings` | [*components.Embeddings](../../models/components/embeddings.mdx) | ➖ | N/A | -| `ImageGeneration` | [*components.ImageGeneration](../../models/components/imagegeneration.mdx) | ➖ | N/A | -| `Rerank` | [*components.Rerank](../../models/components/rerank.mdx) | ➖ | N/A | -| `STT` | [*components.STT](../../models/components/stt.mdx) | ➖ | N/A | -| `TextGeneration` | [*components.TextGeneration](../../models/components/textgeneration.mdx) | ➖ | N/A | -| `TTS` | [*components.TTS](../../models/components/tts.mdx) | ➖ | N/A | -| `Unknown` | [*components.Unknown](../../models/components/unknown.mdx) | ➖ | N/A | -| `VideoGeneration` | [*components.VideoGeneration](../../models/components/videogeneration.mdx) | ➖ | N/A | \ No newline at end of file +| `Decisions` | [*components.Decisions](../../models/components/decisions.mdx) | :heavy_minus_sign: | N/A | +| `Embeddings` | [*components.Embeddings](../../models/components/embeddings.mdx) | :heavy_minus_sign: | N/A | +| `ImageGeneration` | [*components.ImageGeneration](../../models/components/imagegeneration.mdx) | :heavy_minus_sign: | N/A | +| `Rerank` | [*components.Rerank](../../models/components/rerank.mdx) | :heavy_minus_sign: | N/A | +| `STT` | [*components.STT](../../models/components/stt.mdx) | :heavy_minus_sign: | N/A | +| `TextGeneration` | [*components.TextGeneration](../../models/components/textgeneration.mdx) | :heavy_minus_sign: | N/A | +| `TTS` | [*components.TTS](../../models/components/tts.mdx) | :heavy_minus_sign: | N/A | +| `Unknown` | [*components.Unknown](../../models/components/unknown.mdx) | :heavy_minus_sign: | N/A | +| `VideoGeneration` | [*components.VideoGeneration](../../models/components/videogeneration.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/perrequestlimits.mdx b/docs/models/components/perrequestlimits.mdx index b18992532..57dfcd45c 100644 --- a/docs/models/components/perrequestlimits.mdx +++ b/docs/models/components/perrequestlimits.mdx @@ -9,5 +9,5 @@ Per-request token limits | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `CompletionTokens` | `float64` | ✅ | Maximum completion tokens per request | 1000 | -| `PromptTokens` | `float64` | ✅ | Maximum prompt tokens per request | 1000 | \ No newline at end of file +| `CompletionTokens` | `float64` | :heavy_check_mark: | Maximum completion tokens per request | 1000 | +| `PromptTokens` | `float64` | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | \ No newline at end of file diff --git a/docs/models/components/pipelinestage.mdx b/docs/models/components/pipelinestage.mdx index 03a8a387f..ced1b8f85 100644 --- a/docs/models/components/pipelinestage.mdx +++ b/docs/models/components/pipelinestage.mdx @@ -6,10 +6,10 @@ title: "PipelineStage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CostUsd` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | -| `Data` | map[string]`any` | ➖ | N/A | | -| `GuardrailID` | `*string` | ➖ | N/A | | -| `GuardrailScope` | `*string` | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Summary` | `*string` | ➖ | N/A | | -| `Type` | [components.PipelineStageType](../../models/components/pipelinestagetype.mdx) | ✅ | Categorical kind of a pipeline stage. Multiple plugins can share a type (e.g. all guardrail-level plugins emit `guardrail`); the `name` field disambiguates which plugin emitted it. | guardrail | \ No newline at end of file +| `CostUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | +| `Data` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `GuardrailID` | `*string` | :heavy_minus_sign: | N/A | | +| `GuardrailScope` | `*string` | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Summary` | `*string` | :heavy_minus_sign: | N/A | | +| `Type` | [components.PipelineStageType](../../models/components/pipelinestagetype.mdx) | :heavy_check_mark: | Categorical kind of a pipeline stage. Multiple plugins can share a type (e.g. all guardrail-level plugins emit `guardrail`); the `name` field disambiguates which plugin emitted it. | guardrail | \ No newline at end of file diff --git a/docs/models/components/prediction.mdx b/docs/models/components/prediction.mdx index 10d6d26ae..5cbb82074 100644 --- a/docs/models/components/prediction.mdx +++ b/docs/models/components/prediction.mdx @@ -9,5 +9,5 @@ Static predicted output content. Supported models can use this to reduce latency | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Content` | [components.PredictionContent](../../models/components/predictioncontent.mdx) | ✅ | N/A | -| `Type` | [components.PredictionType](../../models/components/predictiontype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [components.PredictionContent](../../models/components/predictioncontent.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.PredictionType](../../models/components/predictiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/predictioncontenttext.mdx b/docs/models/components/predictioncontenttext.mdx index 6242b5429..d28120b65 100644 --- a/docs/models/components/predictioncontenttext.mdx +++ b/docs/models/components/predictioncontenttext.mdx @@ -9,5 +9,5 @@ Text content part for a predicted output. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.PredictionContentTextType](../../models/components/predictioncontenttexttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.PredictionContentTextType](../../models/components/predictioncontenttexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/preset.mdx b/docs/models/components/preset.mdx index c3cf8e279..33eec201c 100644 --- a/docs/models/components/preset.mdx +++ b/docs/models/components/preset.mdx @@ -9,14 +9,14 @@ A preset without version details. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `CreatedAt` | `string` | ✅ | N/A | | -| `CreatorUserID` | `*string` | ✅ | N/A | | -| `Description` | `*string` | ✅ | N/A | | -| `DesignatedVersionID` | `*string` | ✅ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Slug` | `string` | ✅ | N/A | | -| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | ✅ | The status of a preset. | active | -| `StatusUpdatedAt` | `*string` | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | N/A | | -| `WorkspaceID` | `*string` | ✅ | N/A | | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | N/A | | +| `CreatorUserID` | `*string` | :heavy_check_mark: | N/A | | +| `Description` | `*string` | :heavy_check_mark: | N/A | | +| `DesignatedVersionID` | `*string` | :heavy_check_mark: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Slug` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | +| `StatusUpdatedAt` | `*string` | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | | +| `WorkspaceID` | `*string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/presetdesignatedversion.mdx b/docs/models/components/presetdesignatedversion.mdx index 7eaefd95f..94a959054 100644 --- a/docs/models/components/presetdesignatedversion.mdx +++ b/docs/models/components/presetdesignatedversion.mdx @@ -9,11 +9,11 @@ A specific version of a preset, containing config and optional system prompt. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Config` | map[string]`any` | ✅ | N/A | -| `CreatedAt` | `string` | ✅ | N/A | -| `CreatorID` | `string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `PresetID` | `string` | ✅ | N/A | -| `SystemPrompt` | `*string` | ✅ | N/A | -| `UpdatedAt` | `string` | ✅ | N/A | -| `Version` | `int64` | ✅ | N/A | \ No newline at end of file +| `Config` | map[string]`any` | :heavy_check_mark: | N/A | +| `CreatedAt` | `string` | :heavy_check_mark: | N/A | +| `CreatorID` | `string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `PresetID` | `string` | :heavy_check_mark: | N/A | +| `SystemPrompt` | `*string` | :heavy_check_mark: | N/A | +| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | +| `Version` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/presetwithdesignatedversion.mdx b/docs/models/components/presetwithdesignatedversion.mdx index cd2639fbe..bec3d33fb 100644 --- a/docs/models/components/presetwithdesignatedversion.mdx +++ b/docs/models/components/presetwithdesignatedversion.mdx @@ -9,15 +9,15 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | ✅ | N/A | | -| `CreatorUserID` | `*string` | ✅ | N/A | | -| `Description` | `*string` | ✅ | N/A | | -| `DesignatedVersionID` | `*string` | ✅ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Slug` | `string` | ✅ | N/A | | -| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | ✅ | The status of a preset. | active | -| `StatusUpdatedAt` | `*string` | ✅ | N/A | | -| `UpdatedAt` | `string` | ✅ | N/A | | -| `WorkspaceID` | `*string` | ✅ | N/A | | -| `DesignatedVersion` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | ✅ | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | N/A | | +| `CreatorUserID` | `*string` | :heavy_check_mark: | N/A | | +| `Description` | `*string` | :heavy_check_mark: | N/A | | +| `DesignatedVersionID` | `*string` | :heavy_check_mark: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Slug` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | +| `StatusUpdatedAt` | `*string` | :heavy_check_mark: | N/A | | +| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | | +| `WorkspaceID` | `*string` | :heavy_check_mark: | N/A | | +| `DesignatedVersion` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | :heavy_check_mark: | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file diff --git a/docs/models/components/preview20250311websearchservertool.mdx b/docs/models/components/preview20250311websearchservertool.mdx index dc1656307..9b7a4bf9b 100644 --- a/docs/models/components/preview20250311websearchservertool.mdx +++ b/docs/models/components/preview20250311websearchservertool.mdx @@ -9,12 +9,12 @@ Web search preview tool configuration (2025-03-11 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | -| `Type` | [components.Preview20250311WebSearchServerToolType](../../models/components/preview20250311websearchservertooltype.mdx) | ✅ | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `Type` | [components.Preview20250311WebSearchServerToolType](../../models/components/preview20250311websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/previewwebsearchservertool.mdx b/docs/models/components/previewwebsearchservertool.mdx index 913c2d519..b0b325a88 100644 --- a/docs/models/components/previewwebsearchservertool.mdx +++ b/docs/models/components/previewwebsearchservertool.mdx @@ -9,12 +9,12 @@ Web search preview tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | -| `Type` | [components.PreviewWebSearchServerToolType](../../models/components/previewwebsearchservertooltype.mdx) | ✅ | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `Type` | [components.PreviewWebSearchServerToolType](../../models/components/previewwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/previewwebsearchuserlocation.mdx b/docs/models/components/previewwebsearchuserlocation.mdx index 8c41c3cb7..e0ffc5a49 100644 --- a/docs/models/components/previewwebsearchuserlocation.mdx +++ b/docs/models/components/previewwebsearchuserlocation.mdx @@ -6,8 +6,8 @@ title: "PreviewWebSearchUserLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.PreviewWebSearchUserLocationType](../../models/components/previewwebsearchuserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.PreviewWebSearchUserLocationType](../../models/components/previewwebsearchuserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/pricing.mdx b/docs/models/components/pricing.mdx index 4d14c44f7..9f14372a8 100644 --- a/docs/models/components/pricing.mdx +++ b/docs/models/components/pricing.mdx @@ -6,19 +6,19 @@ title: "Pricing" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Audio` | `*string` | ➖ | Price in USD per audio input token | -| `AudioOutput` | `*string` | ➖ | Price in USD per audio output token | -| `Completion` | `string` | ✅ | Price in USD per token for completion (output) generation | -| `Discount` | `*float64` | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `Image` | `*string` | ➖ | Price in USD per input image | -| `ImageOutput` | `*string` | ➖ | Price in USD per output image | -| `ImageToken` | `*string` | ➖ | Price in USD per image token | -| `InputAudioCache` | `*string` | ➖ | Price in USD per cached audio input token | -| `InputCacheRead` | `*string` | ➖ | Price in USD per cached input token (read) | -| `InputCacheWrite` | `*string` | ➖ | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | -| `InputCacheWrite1h` | `*string` | ➖ | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | -| `InternalReasoning` | `*string` | ➖ | Price in USD per internal reasoning token | -| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride.mdx) | ➖ | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | -| `Prompt` | `string` | ✅ | Price in USD per token for prompt (input) processing | -| `Request` | `*string` | ➖ | Price in USD per request | -| `WebSearch` | `*string` | ➖ | Price in USD per web search | \ No newline at end of file +| `Audio` | `*string` | :heavy_minus_sign: | Price in USD per audio input token | +| `AudioOutput` | `*string` | :heavy_minus_sign: | Price in USD per audio output token | +| `Completion` | `string` | :heavy_check_mark: | Price in USD per token for completion (output) generation | +| `Discount` | `*float64` | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `Image` | `*string` | :heavy_minus_sign: | Price in USD per input image | +| `ImageOutput` | `*string` | :heavy_minus_sign: | Price in USD per output image | +| `ImageToken` | `*string` | :heavy_minus_sign: | Price in USD per image token | +| `InputAudioCache` | `*string` | :heavy_minus_sign: | Price in USD per cached audio input token | +| `InputCacheRead` | `*string` | :heavy_minus_sign: | Price in USD per cached input token (read) | +| `InputCacheWrite` | `*string` | :heavy_minus_sign: | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | +| `InputCacheWrite1h` | `*string` | :heavy_minus_sign: | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | +| `InternalReasoning` | `*string` | :heavy_minus_sign: | Price in USD per internal reasoning token | +| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride.mdx) | :heavy_minus_sign: | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | +| `Prompt` | `string` | :heavy_check_mark: | Price in USD per token for prompt (input) processing | +| `Request` | `*string` | :heavy_minus_sign: | Price in USD per request | +| `WebSearch` | `*string` | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file diff --git a/docs/models/components/pricingoverride.mdx b/docs/models/components/pricingoverride.mdx index 41af63402..081646d35 100644 --- a/docs/models/components/pricingoverride.mdx +++ b/docs/models/components/pricingoverride.mdx @@ -9,14 +9,14 @@ A conditional override of the base pricing. An entry applies only when all of it | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Audio` | `*string` | ➖ | Overridden price in USD per audio input token | -| `Completion` | `*string` | ➖ | Overridden price in USD per token for completion (output) generation | -| `InputAudioCache` | `*string` | ➖ | Overridden price in USD per cached audio input token | -| `InputCacheRead` | `*string` | ➖ | Overridden price in USD per cached input token (read) | -| `InputCacheWrite` | `*string` | ➖ | Overridden price in USD per cache-write token | -| `InputCacheWrite1h` | `*string` | ➖ | Overridden price in USD per 1-hour cache-write token | -| `MinPromptTokens` | `*float64` | ➖ | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | -| `Prompt` | `*string` | ➖ | Overridden price in USD per token for prompt (input) processing | -| `UtcDays` | [][components.UtcDay](../../models/components/utcday.mdx) | ➖ | Condition: UTC weekdays the entry applies on, evaluated at the request instant. Scopes the utc_start/utc_end window (or, without a window, the whole UTC day) to the listed days. Absent means every day. | -| `UtcEnd` | `*float64` | ➖ | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | -| `UtcStart` | `*float64` | ➖ | Condition: inclusive start of a daily UTC time window as an HHMM clock number (e.g. 100 = 01:00, 1030 = 10:30). The entry applies while the current UTC time is inside the half-open window [utc_start, utc_end), which may wrap past midnight (utc_start > utc_end). | \ No newline at end of file +| `Audio` | `*string` | :heavy_minus_sign: | Overridden price in USD per audio input token | +| `Completion` | `*string` | :heavy_minus_sign: | Overridden price in USD per token for completion (output) generation | +| `InputAudioCache` | `*string` | :heavy_minus_sign: | Overridden price in USD per cached audio input token | +| `InputCacheRead` | `*string` | :heavy_minus_sign: | Overridden price in USD per cached input token (read) | +| `InputCacheWrite` | `*string` | :heavy_minus_sign: | Overridden price in USD per cache-write token | +| `InputCacheWrite1h` | `*string` | :heavy_minus_sign: | Overridden price in USD per 1-hour cache-write token | +| `MinPromptTokens` | `*float64` | :heavy_minus_sign: | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | +| `Prompt` | `*string` | :heavy_minus_sign: | Overridden price in USD per token for prompt (input) processing | +| `UtcDays` | [][components.UtcDay](../../models/components/utcday.mdx) | :heavy_minus_sign: | Condition: UTC weekdays the entry applies on, evaluated at the request instant. Scopes the utc_start/utc_end window (or, without a window, the whole UTC day) to the listed days. Absent means every day. | +| `UtcEnd` | `*float64` | :heavy_minus_sign: | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | +| `UtcStart` | `*float64` | :heavy_minus_sign: | Condition: inclusive start of a daily UTC time window as an HHMM clock number (e.g. 100 = 01:00, 1030 = 10:30). The entry applies while the current UTC time is inside the half-open window [utc_start, utc_end), which may wrap past midnight (utc_start > utc_end). | \ No newline at end of file diff --git a/docs/models/components/privateendpoint.mdx b/docs/models/components/privateendpoint.mdx index f136d9441..2c5d84e65 100644 --- a/docs/models/components/privateendpoint.mdx +++ b/docs/models/components/privateendpoint.mdx @@ -6,15 +6,15 @@ title: "PrivateEndpoint" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BaseURL` | `*string` | ✅ | HTTPS base URL of your deployment, or `null` for providers whose URL is derived from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `DeclaredRegion` | [*components.PrivateEndpointDeclaredRegion](../../models/components/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `DeclaredZdr` | `*bool` | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `ModelName` | `*string` | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `ModelPermaslug` | `string` | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `ModelSlug` | `*string` | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `Pricing` | [components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `ProviderName` | `string` | ✅ | Display name of the upstream provider. | Azure | -| `ProviderSlug` | `*string` | ✅ | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | -| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | -| `UpstreamModelID` | `string` | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `BaseURL` | `*string` | :heavy_check_mark: | HTTPS base URL of your deployment, or `null` for providers whose URL is derived from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `DeclaredRegion` | [*components.PrivateEndpointDeclaredRegion](../../models/components/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `DeclaredZdr` | `*bool` | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `ModelName` | `*string` | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `ModelSlug` | `*string` | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `Pricing` | [components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `ProviderName` | `string` | :heavy_check_mark: | Display name of the upstream provider. | Azure | +| `ProviderSlug` | `*string` | :heavy_check_mark: | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | +| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | +| `UpstreamModelID` | `string` | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/components/privateendpointactivation.mdx b/docs/models/components/privateendpointactivation.mdx index 7f4328a43..49915baf3 100644 --- a/docs/models/components/privateendpointactivation.mdx +++ b/docs/models/components/privateendpointactivation.mdx @@ -9,4 +9,4 @@ Validate and activate in the same call. On a failed validation the draft is kept | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `WorkspaceID` | `string` | ✅ | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `WorkspaceID` | `string` | :heavy_check_mark: | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/privateendpointcheck.mdx b/docs/models/components/privateendpointcheck.mdx index 81d19f15a..d7cf98a6e 100644 --- a/docs/models/components/privateendpointcheck.mdx +++ b/docs/models/components/privateendpointcheck.mdx @@ -6,9 +6,9 @@ title: "PrivateEndpointCheck" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `ActualModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Model the upstream reported serving, when it differs from the request. | | -| `Name` | `string` | ✅ | Check name. | auth_ok | -| `Passed` | `bool` | ✅ | N/A | | -| `Reason` | [*components.PrivateEndpointCheckReason](../../models/components/privateendpointcheckreason.mdx) | ➖ | Why the check failed. | no_byok_key | -| `UpstreamMessage` | optionalnullable.OptionalNullable[`string`] | ➖ | Error message returned by your deployment when the call failed. | | -| `UpstreamStatus` | `*int64` | ➖ | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file +| `ActualModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Model the upstream reported serving, when it differs from the request. | | +| `Name` | `string` | :heavy_check_mark: | Check name. | auth_ok | +| `Passed` | `bool` | :heavy_check_mark: | N/A | | +| `Reason` | [*components.PrivateEndpointCheckReason](../../models/components/privateendpointcheckreason.mdx) | :heavy_minus_sign: | Why the check failed. | no_byok_key | +| `UpstreamMessage` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Error message returned by your deployment when the call failed. | | +| `UpstreamStatus` | `*int64` | :heavy_minus_sign: | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file diff --git a/docs/models/components/privateendpointpricing.mdx b/docs/models/components/privateendpointpricing.mdx index 560e0c9aa..e998f5335 100644 --- a/docs/models/components/privateendpointpricing.mdx +++ b/docs/models/components/privateendpointpricing.mdx @@ -9,5 +9,5 @@ Negotiated per-token rates reported for requests routed to this endpoint. | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `Completion` | `string` | ✅ | USD per completion token, as a decimal string. | 0.00001 | -| `Prompt` | `string` | ✅ | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file +| `Completion` | `string` | :heavy_check_mark: | USD per completion token, as a decimal string. | 0.00001 | +| `Prompt` | `string` | :heavy_check_mark: | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file diff --git a/docs/models/components/privateendpointresponse.mdx b/docs/models/components/privateendpointresponse.mdx index ed0568243..71ee6ad29 100644 --- a/docs/models/components/privateendpointresponse.mdx +++ b/docs/models/components/privateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "PrivateEndpointResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PrivateEndpoint](../../models/components/privateendpoint.mdx) | ✅ | N/A | \{
"base_url": "https://contoso.openai.azure.com",
"declared_region": "us",
"declared_zdr": true,
"id": "5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11",
"model_name": "OpenAI: GPT-4o",
"model_permaslug": "openai/gpt-4o-2024-08-06",
"model_slug": "openai/gpt-4o",
"pricing": \{
"completion": "0.00001",
"prompt": "0.0000025"
},
"provider_name": "Azure",
"provider_slug": "azure",
"status": "active",
"upstream_model_id": "gpt-4o-prod"
} | \ No newline at end of file +| `Data` | [components.PrivateEndpoint](../../models/components/privateendpoint.mdx) | :heavy_check_mark: | N/A | \{
"base_url": "https://contoso.openai.azure.com",
"declared_region": "us",
"declared_zdr": true,
"id": "5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11",
"model_name": "OpenAI: GPT-4o",
"model_permaslug": "openai/gpt-4o-2024-08-06",
"model_slug": "openai/gpt-4o",
"pricing": \{
"completion": "0.00001",
"prompt": "0.0000025"
},
"provider_name": "Azure",
"provider_slug": "azure",
"status": "active",
"upstream_model_id": "gpt-4o-prod"
} | \ No newline at end of file diff --git a/docs/models/components/privateendpointsummary.mdx b/docs/models/components/privateendpointsummary.mdx index 026b6e31b..9b2b9bc9a 100644 --- a/docs/models/components/privateendpointsummary.mdx +++ b/docs/models/components/privateendpointsummary.mdx @@ -6,10 +6,10 @@ title: "PrivateEndpointSummary" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `ModelName` | `*string` | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `ModelPermaslug` | `string` | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `ModelSlug` | `*string` | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `ProviderName` | `string` | ✅ | Display name of the upstream provider. | Azure | -| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `ModelName` | `*string` | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `ModelSlug` | `*string` | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `ProviderName` | `string` | :heavy_check_mark: | Display name of the upstream provider. | Azure | +| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | \ No newline at end of file diff --git a/docs/models/components/privateendpointvalidation.mdx b/docs/models/components/privateendpointvalidation.mdx index 31cd81f72..275a5325d 100644 --- a/docs/models/components/privateendpointvalidation.mdx +++ b/docs/models/components/privateendpointvalidation.mdx @@ -6,5 +6,5 @@ title: "PrivateEndpointValidation" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Checks` | [][components.PrivateEndpointCheck](../../models/components/privateendpointcheck.mdx) | ✅ | N/A | | -| `Passed` | `bool` | ✅ | Whether every check passed. | true | \ No newline at end of file +| `Checks` | [][components.PrivateEndpointCheck](../../models/components/privateendpointcheck.mdx) | :heavy_check_mark: | N/A | | +| `Passed` | `bool` | :heavy_check_mark: | Whether every check passed. | true | \ No newline at end of file diff --git a/docs/models/components/privateendpointvalidationnullable.mdx b/docs/models/components/privateendpointvalidationnullable.mdx index 2516ce73c..2874980d4 100644 --- a/docs/models/components/privateendpointvalidationnullable.mdx +++ b/docs/models/components/privateendpointvalidationnullable.mdx @@ -6,5 +6,5 @@ title: "PrivateEndpointValidationNullable" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Checks` | [][components.PrivateEndpointCheck](../../models/components/privateendpointcheck.mdx) | ✅ | N/A | | -| `Passed` | `bool` | ✅ | Whether every check passed. | true | \ No newline at end of file +| `Checks` | [][components.PrivateEndpointCheck](../../models/components/privateendpointcheck.mdx) | :heavy_check_mark: | N/A | | +| `Passed` | `bool` | :heavy_check_mark: | Whether every check passed. | true | \ No newline at end of file diff --git a/docs/models/components/privateendpointvalidationresponse.mdx b/docs/models/components/privateendpointvalidationresponse.mdx index d070dffa2..61b858d36 100644 --- a/docs/models/components/privateendpointvalidationresponse.mdx +++ b/docs/models/components/privateendpointvalidationresponse.mdx @@ -6,4 +6,4 @@ title: "PrivateEndpointValidationResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Data` | [components.PrivateEndpointValidation](../../models/components/privateendpointvalidation.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.PrivateEndpointValidation](../../models/components/privateendpointvalidation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/progress.mdx b/docs/models/components/progress.mdx index 4b01a7a38..9ca155e3d 100644 --- a/docs/models/components/progress.mdx +++ b/docs/models/components/progress.mdx @@ -9,6 +9,6 @@ Active provisioning step, or null once provisioning has settled. | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `StepLabel` | `string` | ✅ | Human-readable label of the active provisioning step. | -| `StepNumber` | `int64` | ✅ | One-based index of the active step. | -| `TotalSteps` | `int64` | ✅ | Number of provisioning steps. | \ No newline at end of file +| `StepLabel` | `string` | :heavy_check_mark: | Human-readable label of the active provisioning step. | +| `StepNumber` | `int64` | :heavy_check_mark: | One-based index of the active step. | +| `TotalSteps` | `int64` | :heavy_check_mark: | Number of provisioning steps. | \ No newline at end of file diff --git a/docs/models/components/promptcachebreakpoint.mdx b/docs/models/components/promptcachebreakpoint.mdx index 552b9ccca..0c7f5e033 100644 --- a/docs/models/components/promptcachebreakpoint.mdx +++ b/docs/models/components/promptcachebreakpoint.mdx @@ -9,4 +9,4 @@ Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Ev | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Mode` | [components.PromptCacheBreakpointMode](../../models/components/promptcachebreakpointmode.mdx) | ✅ | N/A | \ No newline at end of file +| `Mode` | [components.PromptCacheBreakpointMode](../../models/components/promptcachebreakpointmode.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/promptcacheoptions.mdx b/docs/models/components/promptcacheoptions.mdx index 0cbb412be..6a2316017 100644 --- a/docs/models/components/promptcacheoptions.mdx +++ b/docs/models/components/promptcacheoptions.mdx @@ -9,5 +9,5 @@ Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Mode` | [components.PromptCacheOptionsMode](../../models/components/promptcacheoptionsmode.mdx) | ✅ | N/A | -| `TTL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file +| `Mode` | [components.PromptCacheOptionsMode](../../models/components/promptcacheoptionsmode.mdx) | :heavy_check_mark: | N/A | +| `TTL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/provideroptions.mdx b/docs/models/components/provideroptions.mdx index 3dafb8d56..b6fea2a1b 100644 --- a/docs/models/components/provideroptions.mdx +++ b/docs/models/components/provideroptions.mdx @@ -9,149 +9,149 @@ Provider-specific options keyed by provider slug. Only options for the matched p | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Oneai` | map[string]`any` | ➖ | N/A | -| `Ai21` | map[string]`any` | ➖ | N/A | -| `AionLabs` | map[string]`any` | ➖ | N/A | -| `Akashml` | map[string]`any` | ➖ | N/A | -| `Alibaba` | map[string]`any` | ➖ | N/A | -| `AmazonBedrock` | map[string]`any` | ➖ | N/A | -| `AmazonBedrockClaudeOnAws` | map[string]`any` | ➖ | N/A | -| `AmazonNova` | map[string]`any` | ➖ | N/A | -| `Ambient` | map[string]`any` | ➖ | N/A | -| `Anthropic` | map[string]`any` | ➖ | N/A | -| `Anthropic2` | map[string]`any` | ➖ | N/A | -| `Anyscale` | map[string]`any` | ➖ | N/A | -| `ArceeAi` | map[string]`any` | ➖ | N/A | -| `Assemblyai` | map[string]`any` | ➖ | N/A | -| `AtlasCloud` | map[string]`any` | ➖ | N/A | -| `Atoma` | map[string]`any` | ➖ | N/A | -| `Avian` | map[string]`any` | ➖ | N/A | -| `Azure` | map[string]`any` | ➖ | N/A | -| `Baidu` | map[string]`any` | ➖ | N/A | -| `Baseten` | map[string]`any` | ➖ | N/A | -| `BlackForestLabs` | map[string]`any` | ➖ | N/A | -| `Byteplus` | map[string]`any` | ➖ | N/A | -| `Centml` | map[string]`any` | ➖ | N/A | -| `Cerebras` | map[string]`any` | ➖ | N/A | -| `Chutes` | map[string]`any` | ➖ | N/A | -| `Cirrascale` | map[string]`any` | ➖ | N/A | -| `Clarifai` | map[string]`any` | ➖ | N/A | -| `ClaudeOnAws` | map[string]`any` | ➖ | N/A | -| `Cloudflare` | map[string]`any` | ➖ | N/A | -| `Cohere` | map[string]`any` | ➖ | N/A | -| `Coreweave` | map[string]`any` | ➖ | N/A | -| `Cosine` | map[string]`any` | ➖ | N/A | -| `Crofai` | map[string]`any` | ➖ | N/A | -| `Crucible` | map[string]`any` | ➖ | N/A | -| `Crusoe` | map[string]`any` | ➖ | N/A | -| `Darkbloom` | map[string]`any` | ➖ | N/A | -| `Databricks` | map[string]`any` | ➖ | N/A | -| `Decart` | map[string]`any` | ➖ | N/A | -| `Deepgram` | map[string]`any` | ➖ | N/A | -| `Deepinfra` | map[string]`any` | ➖ | N/A | -| `Deepseek` | map[string]`any` | ➖ | N/A | -| `Dekallm` | map[string]`any` | ➖ | N/A | -| `Digitalocean` | map[string]`any` | ➖ | N/A | -| `Elevenlabs` | map[string]`any` | ➖ | N/A | -| `Enfer` | map[string]`any` | ➖ | N/A | -| `FakeProvider` | map[string]`any` | ➖ | N/A | -| `Featherless` | map[string]`any` | ➖ | N/A | -| `Fireworks` | map[string]`any` | ➖ | N/A | -| `FishAudio` | map[string]`any` | ➖ | N/A | -| `Friendli` | map[string]`any` | ➖ | N/A | -| `Gmicloud` | map[string]`any` | ➖ | N/A | -| `GoogleAiStudio` | map[string]`any` | ➖ | N/A | -| `GoogleVertex` | map[string]`any` | ➖ | N/A | -| `Gopomelo` | map[string]`any` | ➖ | N/A | -| `Groq` | map[string]`any` | ➖ | N/A | -| `Heygen` | map[string]`any` | ➖ | N/A | -| `Huggingface` | map[string]`any` | ➖ | N/A | -| `Hyperbolic` | map[string]`any` | ➖ | N/A | -| `HyperbolicQuantized` | map[string]`any` | ➖ | N/A | -| `Inception` | map[string]`any` | ➖ | N/A | -| `Inceptron` | map[string]`any` | ➖ | N/A | -| `InferactVllm` | map[string]`any` | ➖ | N/A | -| `InferenceNet` | map[string]`any` | ➖ | N/A | -| `Infermatic` | map[string]`any` | ➖ | N/A | -| `Inflection` | map[string]`any` | ➖ | N/A | -| `Inocloud` | map[string]`any` | ➖ | N/A | -| `IoNet` | map[string]`any` | ➖ | N/A | -| `Ionstream` | map[string]`any` | ➖ | N/A | -| `Klusterai` | map[string]`any` | ➖ | N/A | -| `Krea` | map[string]`any` | ➖ | N/A | -| `Lambda` | map[string]`any` | ➖ | N/A | -| `Lepton` | map[string]`any` | ➖ | N/A | -| `Liquid` | map[string]`any` | ➖ | N/A | -| `Lynn` | map[string]`any` | ➖ | N/A | -| `LynnPrivate` | map[string]`any` | ➖ | N/A | -| `Makora` | map[string]`any` | ➖ | N/A | -| `Mancer` | map[string]`any` | ➖ | N/A | -| `MancerOld` | map[string]`any` | ➖ | N/A | -| `Mara` | map[string]`any` | ➖ | N/A | -| `Meta` | map[string]`any` | ➖ | N/A | -| `Minimax` | map[string]`any` | ➖ | N/A | -| `Mistral` | map[string]`any` | ➖ | N/A | -| `Modal` | map[string]`any` | ➖ | N/A | -| `Modelrun` | map[string]`any` | ➖ | N/A | -| `Modular` | map[string]`any` | ➖ | N/A | -| `Moonshotai` | map[string]`any` | ➖ | N/A | -| `Morph` | map[string]`any` | ➖ | N/A | -| `Ncompass` | map[string]`any` | ➖ | N/A | -| `NearAi` | map[string]`any` | ➖ | N/A | -| `Nebius` | map[string]`any` | ➖ | N/A | -| `NexAgi` | map[string]`any` | ➖ | N/A | -| `Nextbit` | map[string]`any` | ➖ | N/A | -| `Nineteen` | map[string]`any` | ➖ | N/A | -| `Novita` | map[string]`any` | ➖ | N/A | -| `Nvidia` | map[string]`any` | ➖ | N/A | -| `Octoai` | map[string]`any` | ➖ | N/A | -| `Ollama` | map[string]`any` | ➖ | N/A | -| `OpenInference` | map[string]`any` | ➖ | N/A | -| `Openai` | map[string]`any` | ➖ | N/A | -| `Parasail` | map[string]`any` | ➖ | N/A | -| `Perceptron` | map[string]`any` | ➖ | N/A | -| `Perplexity` | map[string]`any` | ➖ | N/A | -| `Phala` | map[string]`any` | ➖ | N/A | -| `Poolside` | map[string]`any` | ➖ | N/A | -| `Primeintellect` | map[string]`any` | ➖ | N/A | -| `Quiver` | map[string]`any` | ➖ | N/A | -| `Recraft` | map[string]`any` | ➖ | N/A | -| `Recursal` | map[string]`any` | ➖ | N/A | -| `Reflection` | map[string]`any` | ➖ | N/A | -| `Reka` | map[string]`any` | ➖ | N/A | -| `Relace` | map[string]`any` | ➖ | N/A | -| `Replicate` | map[string]`any` | ➖ | N/A | -| `Respan` | map[string]`any` | ➖ | N/A | -| `Runway` | map[string]`any` | ➖ | N/A | -| `SailResearch` | map[string]`any` | ➖ | N/A | -| `Sakana` | map[string]`any` | ➖ | N/A | -| `SakanaAi` | map[string]`any` | ➖ | N/A | -| `Sambanova` | map[string]`any` | ➖ | N/A | -| `SambanovaCloaked` | map[string]`any` | ➖ | N/A | -| `Scaledown` | map[string]`any` | ➖ | N/A | -| `Seed` | map[string]`any` | ➖ | N/A | -| `SfCompute` | map[string]`any` | ➖ | N/A | -| `Siliconflow` | map[string]`any` | ➖ | N/A | -| `Sourceful` | map[string]`any` | ➖ | N/A | -| `Stealth` | map[string]`any` | ➖ | N/A | -| `Stepfun` | map[string]`any` | ➖ | N/A | -| `Streamlake` | map[string]`any` | ➖ | N/A | -| `Switchpoint` | map[string]`any` | ➖ | N/A | -| `Targon` | map[string]`any` | ➖ | N/A | -| `Tencent` | map[string]`any` | ➖ | N/A | -| `Tenstorrent` | map[string]`any` | ➖ | N/A | -| `Thinkingmachines` | map[string]`any` | ➖ | N/A | -| `Together` | map[string]`any` | ➖ | N/A | -| `TogetherLite` | map[string]`any` | ➖ | N/A | -| `Typesafe` | map[string]`any` | ➖ | N/A | -| `Ubicloud` | map[string]`any` | ➖ | N/A | -| `Unbiased` | map[string]`any` | ➖ | N/A | -| `Upstage` | map[string]`any` | ➖ | N/A | -| `Venice` | map[string]`any` | ➖ | N/A | -| `Voyageai` | map[string]`any` | ➖ | N/A | -| `Wafer` | map[string]`any` | ➖ | N/A | -| `Wandb` | map[string]`any` | ➖ | N/A | -| `WandbLegacy` | map[string]`any` | ➖ | N/A | -| `Xai` | map[string]`any` | ➖ | N/A | -| `Xiaomi` | map[string]`any` | ➖ | N/A | -| `ZAi` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Oneai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ai21` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AionLabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Akashml` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Alibaba` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonBedrock` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonBedrockClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonNova` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ambient` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anthropic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anthropic2` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anyscale` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ArceeAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Assemblyai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AtlasCloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Atoma` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Avian` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Azure` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Baidu` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Baseten` | map[string]`any` | :heavy_minus_sign: | N/A | +| `BlackForestLabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Byteplus` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Centml` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cerebras` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Chutes` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cirrascale` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Clarifai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cloudflare` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cohere` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Coreweave` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cosine` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crofai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crucible` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crusoe` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Darkbloom` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Databricks` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Decart` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepgram` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepinfra` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepseek` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Dekallm` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Digitalocean` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Elevenlabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Enfer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `FakeProvider` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Featherless` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Fireworks` | map[string]`any` | :heavy_minus_sign: | N/A | +| `FishAudio` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Friendli` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Gmicloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `GoogleAiStudio` | map[string]`any` | :heavy_minus_sign: | N/A | +| `GoogleVertex` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Gopomelo` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Groq` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Heygen` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Huggingface` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Hyperbolic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `HyperbolicQuantized` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inception` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inceptron` | map[string]`any` | :heavy_minus_sign: | N/A | +| `InferactVllm` | map[string]`any` | :heavy_minus_sign: | N/A | +| `InferenceNet` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Infermatic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inflection` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inocloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `IoNet` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ionstream` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Klusterai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Krea` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lambda` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lepton` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Liquid` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lynn` | map[string]`any` | :heavy_minus_sign: | N/A | +| `LynnPrivate` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Makora` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mancer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `MancerOld` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mara` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Meta` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Minimax` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mistral` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modal` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modelrun` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modular` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Moonshotai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Morph` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ncompass` | map[string]`any` | :heavy_minus_sign: | N/A | +| `NearAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nebius` | map[string]`any` | :heavy_minus_sign: | N/A | +| `NexAgi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nextbit` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nineteen` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Novita` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nvidia` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Octoai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ollama` | map[string]`any` | :heavy_minus_sign: | N/A | +| `OpenInference` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Openai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Parasail` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Perceptron` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Perplexity` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Phala` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Poolside` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Primeintellect` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Quiver` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Recraft` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Recursal` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Reflection` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Reka` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Relace` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Replicate` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Respan` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Runway` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SailResearch` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sakana` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SakanaAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sambanova` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SambanovaCloaked` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Scaledown` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Seed` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SfCompute` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Siliconflow` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sourceful` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Stealth` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Stepfun` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Streamlake` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Switchpoint` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Targon` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Tencent` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Tenstorrent` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Thinkingmachines` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Together` | map[string]`any` | :heavy_minus_sign: | N/A | +| `TogetherLite` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Typesafe` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ubicloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Unbiased` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Upstage` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Venice` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Voyageai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Wafer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Wandb` | map[string]`any` | :heavy_minus_sign: | N/A | +| `WandbLegacy` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Xai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Xiaomi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ZAi` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/provideroverloadedresponseerrordata.mdx b/docs/models/components/provideroverloadedresponseerrordata.mdx index 4b65aaacb..5646fd73b 100644 --- a/docs/models/components/provideroverloadedresponseerrordata.mdx +++ b/docs/models/components/provideroverloadedresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ProviderOverloadedResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/providerpreferences.mdx b/docs/models/components/providerpreferences.mdx index e09dbc2d3..09dcd175f 100644 --- a/docs/models/components/providerpreferences.mdx +++ b/docs/models/components/providerpreferences.mdx @@ -9,17 +9,17 @@ Provider routing preferences for the request. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `DataCollection` | optionalnullable.OptionalNullable[[components.DataCollection](../../models/components/datacollection.mdx)] | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `EnforceDistillableText` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | -| `Ignore` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesIgnore](../../models/components/providerpreferencesignore.mdx)] | ➖ | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | -| `MaxPrice` | [*components.MaxPrice](../../models/components/maxprice.mdx) | ➖ | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. | | -| `Only` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOnly](../../models/components/providerpreferencesonly.mdx)] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | -| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `Order` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOrder](../../models/components/providerpreferencesorder.mdx)] | ➖ | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | -| `PreferredMaxLatency` | optionalnullable.OptionalNullable[[components.PreferredMaxLatency](../../models/components/preferredmaxlatency.mdx)] | ➖ | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | -| `PreferredMinThroughput` | optionalnullable.OptionalNullable[[components.PreferredMinThroughput](../../models/components/preferredminthroughput.mdx)] | ➖ | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | -| `Quantizations` | optionalnullable.OptionalNullable[[][components.Quantization](../../models/components/quantization.mdx)] | ➖ | A list of quantization levels to filter the provider by. | | -| `RequireParameters` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | -| `Sort` | optionalnullable.OptionalNullable[[components.ProviderPreferencesSort](../../models/components/providerpreferencessort.mdx)] | ➖ | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | -| `Zdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `DataCollection` | optionalnullable.OptionalNullable[[components.DataCollection](../../models/components/datacollection.mdx)] | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `EnforceDistillableText` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | +| `Ignore` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesIgnore](../../models/components/providerpreferencesignore.mdx)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | +| `MaxPrice` | [*components.MaxPrice](../../models/components/maxprice.mdx) | :heavy_minus_sign: | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. | | +| `Only` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOnly](../../models/components/providerpreferencesonly.mdx)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | +| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `Order` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOrder](../../models/components/providerpreferencesorder.mdx)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | +| `PreferredMaxLatency` | optionalnullable.OptionalNullable[[components.PreferredMaxLatency](../../models/components/preferredmaxlatency.mdx)] | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | +| `PreferredMinThroughput` | optionalnullable.OptionalNullable[[components.PreferredMinThroughput](../../models/components/preferredminthroughput.mdx)] | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | +| `Quantizations` | optionalnullable.OptionalNullable[[][components.Quantization](../../models/components/quantization.mdx)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | +| `RequireParameters` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | +| `Sort` | optionalnullable.OptionalNullable[[components.ProviderPreferencesSort](../../models/components/providerpreferencessort.mdx)] | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | +| `Zdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/components/providerresponse.mdx b/docs/models/components/providerresponse.mdx index e2a04e148..3b9019d03 100644 --- a/docs/models/components/providerresponse.mdx +++ b/docs/models/components/providerresponse.mdx @@ -9,11 +9,11 @@ Details of a provider response for a generation attempt | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `EndpointID` | `*string` | ➖ | Internal endpoint identifier | ep_abc123 | -| `ID` | `*string` | ➖ | Upstream provider response identifier | chatcmpl-abc123 | -| `IsBYOK` | `*bool` | ➖ | Whether the request used a bring-your-own-key | false | -| `Latency` | `*float64` | ➖ | Response latency in milliseconds | 1200 | -| `ModelPermaslug` | `*string` | ➖ | Canonical model slug | openai/gpt-4 | -| `ProviderName` | [*components.ProviderResponseProviderName](../../models/components/providerresponseprovidername.mdx) | ➖ | Name of the provider | OpenAI | -| `RoutedServiceTier` | [*components.RoutedServiceTier](../../models/components/routedservicetier.mdx) | ➖ | The service tier this request was routed to (e.g. flex, priority). The tier actually applied and billed is determined by the provider response and may differ. | priority | -| `Status` | `*int64` | ✅ | HTTP status code from the provider | 200 | \ No newline at end of file +| `EndpointID` | `*string` | :heavy_minus_sign: | Internal endpoint identifier | ep_abc123 | +| `ID` | `*string` | :heavy_minus_sign: | Upstream provider response identifier | chatcmpl-abc123 | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | +| `Latency` | `*float64` | :heavy_minus_sign: | Response latency in milliseconds | 1200 | +| `ModelPermaslug` | `*string` | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | +| `ProviderName` | [*components.ProviderResponseProviderName](../../models/components/providerresponseprovidername.mdx) | :heavy_minus_sign: | Name of the provider | OpenAI | +| `RoutedServiceTier` | [*components.RoutedServiceTier](../../models/components/routedservicetier.mdx) | :heavy_minus_sign: | The service tier this request was routed to (e.g. flex, priority). The tier actually applied and billed is determined by the provider response and may differ. | priority | +| `Status` | `*int64` | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/docs/models/components/providersortconfig.mdx b/docs/models/components/providersortconfig.mdx index 886518613..aa7bef7f4 100644 --- a/docs/models/components/providersortconfig.mdx +++ b/docs/models/components/providersortconfig.mdx @@ -9,5 +9,5 @@ The provider sorting strategy (price, throughput, latency) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `By` | optionalnullable.OptionalNullable[[components.By](../../models/components/by.mdx)] | ➖ | The provider sorting strategy (price, throughput, latency) | price | -| `Partition` | optionalnullable.OptionalNullable[[components.Partition](../../models/components/partition.mdx)] | ➖ | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model | \ No newline at end of file +| `By` | optionalnullable.OptionalNullable[[components.By](../../models/components/by.mdx)] | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | +| `Partition` | optionalnullable.OptionalNullable[[components.Partition](../../models/components/partition.mdx)] | :heavy_minus_sign: | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model | \ No newline at end of file diff --git a/docs/models/components/provisioninternresponse.mdx b/docs/models/components/provisioninternresponse.mdx index b66e8f3c4..0b1066907 100644 --- a/docs/models/components/provisioninternresponse.mdx +++ b/docs/models/components/provisioninternresponse.mdx @@ -6,4 +6,4 @@ title: "ProvisionInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Provisioning` | `bool` | ✅ | N/A | \ No newline at end of file +| `Provisioning` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/publicendpoint.mdx b/docs/models/components/publicendpoint.mdx index 96859bce0..fd59f8a65 100644 --- a/docs/models/components/publicendpoint.mdx +++ b/docs/models/components/publicendpoint.mdx @@ -9,27 +9,27 @@ Information about a specific model endpoint | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContextLength` | `int64` | ✅ | N/A | | -| `LatencyLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | Latency percentiles in milliseconds over the last 30 minutes. Latency measures time to first token. Only visible when authenticated with an API key or cookie; returns null for unauthenticated requests. | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `MaxCompletionTokens` | `*int64` | ✅ | Maximum completion tokens for this endpoint. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | | -| `MaxPromptTokens` | `*int64` | ✅ | N/A | | -| `ModelID` | `string` | ✅ | The unique identifier for the model (permaslug) | openai/gpt-4 | -| `ModelName` | `string` | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `NativeTools` | map[string][components.NativeTools](../../models/components/nativetools.mdx) | ✅ | The server tools this endpoint accepts as the provider's own built-in tool (`engine: "native"`) instead of an OpenRouter engine, keyed by canonical `openrouter:*` name. Each value names the provider tool type the request is translated to. Where that tool runs (provider-side, or returned to the client as with Anthropic bash) is documented per tool. Empty when the provider has none. | \{
"openrouter:web_search": \{
"type": "web_search_20260209"
}
} | -| `PerfLast30mByWorkload` | [*components.PerfLast30mByWorkload](../../models/components/perflast30mbyworkload.mdx) | ➖ | Endpoint performance over the last 30 minutes, keyed by the kind of request served (e.g. `text_generation`, `image_generation`). Additive to the legacy singular latency and throughput fields; image and video generation report end-to-end latency. Only visible when authenticated with an API key or cookie. | | -| `Pricing` | [components.Pricing](../../models/components/pricing.mdx) | ✅ | N/A | | -| `ProviderName` | [components.ProviderName](../../models/components/providername.mdx) | ✅ | N/A | OpenAI | -| `Quantization` | [*components.Quantization](../../models/components/quantization.mdx) | ✅ | N/A | fp16 | -| `Status` | [*components.EndpointStatus](../../models/components/endpointstatus.mdx) | ➖ | N/A | 0 | -| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | ✅ | N/A | | -| `SupportsImageReference` | `*bool` | ➖ | Whether this TTS endpoint accepts an `image_url` reference describing the desired voice. Requests carrying an image reference are only routed to endpoints where this is true. | | -| `SupportsImplicitCaching` | `bool` | ✅ | N/A | | -| `SupportsMultipleAudioReferences` | `*bool` | ➖ | Whether this TTS endpoint accepts more than one `input_audio` reference clip per request. Requests carrying several clips are only routed to endpoints where this is true. | | -| `SupportsToolChoice` | [components.ToolChoiceSupport](../../models/components/toolchoicesupport.mdx) | ✅ | Per-variant `tool_choice` support. `tool_choice` in `supported_parameters` only says the parameter is accepted; these flags say which of its values passed testing. | \{
"auto": true,
"function": true,
"none": true,
"required": true
} | -| `SupportsVoiceCloning` | `*bool` | ➖ | Whether this TTS endpoint accepts inline reference audio (`input_references`) for stateless voice cloning. Requests carrying reference audio are only routed to endpoints where this is true. | | -| `Tag` | `string` | ✅ | N/A | | -| `ThroughputLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `UptimeLast1d` | `*float64` | ✅ | Uptime percentage over the last day: the share of minutes in which at least 80% of provider attempts succeeded, counting only minutes with 10 or more attempts. Rate-limited and caller-caused failures are excluded. Null when no minute had enough traffic. | | -| `UptimeLast30m` | `*float64` | ✅ | N/A | | -| `UptimeLast5m` | `*float64` | ✅ | Uptime percentage over the last 5 minutes: the share of minutes in which at least 80% of provider attempts succeeded, counting only minutes with 10 or more attempts. Rate-limited and caller-caused failures are excluded. Null when no minute had enough traffic. | | \ No newline at end of file +| `ContextLength` | `int64` | :heavy_check_mark: | N/A | | +| `LatencyLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | Latency percentiles in milliseconds over the last 30 minutes. Latency measures time to first token. Only visible when authenticated with an API key or cookie; returns null for unauthenticated requests. | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `MaxCompletionTokens` | `*int64` | :heavy_check_mark: | Maximum completion tokens for this endpoint. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | | +| `MaxPromptTokens` | `*int64` | :heavy_check_mark: | N/A | | +| `ModelID` | `string` | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 | +| `ModelName` | `string` | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `NativeTools` | map[string][components.NativeTools](../../models/components/nativetools.mdx) | :heavy_check_mark: | The server tools this endpoint accepts as the provider's own built-in tool (`engine: "native"`) instead of an OpenRouter engine, keyed by canonical `openrouter:*` name. Each value names the provider tool type the request is translated to. Where that tool runs (provider-side, or returned to the client as with Anthropic bash) is documented per tool. Empty when the provider has none. | \{
"openrouter:web_search": \{
"type": "web_search_20260209"
}
} | +| `PerfLast30mByWorkload` | [*components.PerfLast30mByWorkload](../../models/components/perflast30mbyworkload.mdx) | :heavy_minus_sign: | Endpoint performance over the last 30 minutes, keyed by the kind of request served (e.g. `text_generation`, `image_generation`). Additive to the legacy singular latency and throughput fields; image and video generation report end-to-end latency. Only visible when authenticated with an API key or cookie. | | +| `Pricing` | [components.Pricing](../../models/components/pricing.mdx) | :heavy_check_mark: | N/A | | +| `ProviderName` | [components.ProviderName](../../models/components/providername.mdx) | :heavy_check_mark: | N/A | OpenAI | +| `Quantization` | [*components.Quantization](../../models/components/quantization.mdx) | :heavy_check_mark: | N/A | fp16 | +| `Status` | [*components.EndpointStatus](../../models/components/endpointstatus.mdx) | :heavy_minus_sign: | N/A | 0 | +| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | :heavy_check_mark: | N/A | | +| `SupportsImageReference` | `*bool` | :heavy_minus_sign: | Whether this TTS endpoint accepts an `image_url` reference describing the desired voice. Requests carrying an image reference are only routed to endpoints where this is true. | | +| `SupportsImplicitCaching` | `bool` | :heavy_check_mark: | N/A | | +| `SupportsMultipleAudioReferences` | `*bool` | :heavy_minus_sign: | Whether this TTS endpoint accepts more than one `input_audio` reference clip per request. Requests carrying several clips are only routed to endpoints where this is true. | | +| `SupportsToolChoice` | [components.ToolChoiceSupport](../../models/components/toolchoicesupport.mdx) | :heavy_check_mark: | Per-variant `tool_choice` support. `tool_choice` in `supported_parameters` only says the parameter is accepted; these flags say which of its values passed testing. | \{
"auto": true,
"function": true,
"none": true,
"required": true
} | +| `SupportsVoiceCloning` | `*bool` | :heavy_minus_sign: | Whether this TTS endpoint accepts inline reference audio (`input_references`) for stateless voice cloning. Requests carrying reference audio are only routed to endpoints where this is true. | | +| `Tag` | `string` | :heavy_check_mark: | N/A | | +| `ThroughputLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `UptimeLast1d` | `*float64` | :heavy_check_mark: | Uptime percentage over the last day: the share of minutes in which at least 80% of provider attempts succeeded, counting only minutes with 10 or more attempts. Rate-limited and caller-caused failures are excluded. Null when no minute had enough traffic. | | +| `UptimeLast30m` | `*float64` | :heavy_check_mark: | N/A | | +| `UptimeLast5m` | `*float64` | :heavy_check_mark: | Uptime percentage over the last 5 minutes: the share of minutes in which at least 80% of provider attempts succeeded, counting only minutes with 10 or more attempts. Rate-limited and caller-caused failures are excluded. Null when no minute had enough traffic. | | \ No newline at end of file diff --git a/docs/models/components/publicpricing.mdx b/docs/models/components/publicpricing.mdx index 79b50e554..68789233c 100644 --- a/docs/models/components/publicpricing.mdx +++ b/docs/models/components/publicpricing.mdx @@ -9,19 +9,19 @@ Pricing information for the model | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Audio` | `*string` | ➖ | Price in USD per audio input token | -| `AudioOutput` | `*string` | ➖ | Price in USD per audio output token | -| `Completion` | `string` | ✅ | Price in USD per token for completion (output) generation | -| `Discount` | `*float64` | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `Image` | `*string` | ➖ | Price in USD per input image | -| `ImageOutput` | `*string` | ➖ | Price in USD per output image | -| `ImageToken` | `*string` | ➖ | Price in USD per image token | -| `InputAudioCache` | `*string` | ➖ | Price in USD per cached audio input token | -| `InputCacheRead` | `*string` | ➖ | Price in USD per cached input token (read) | -| `InputCacheWrite` | `*string` | ➖ | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | -| `InputCacheWrite1h` | `*string` | ➖ | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | -| `InternalReasoning` | `*string` | ➖ | Price in USD per internal reasoning token | -| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride.mdx) | ➖ | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | -| `Prompt` | `string` | ✅ | Price in USD per token for prompt (input) processing | -| `Request` | `*string` | ➖ | Price in USD per request | -| `WebSearch` | `*string` | ➖ | Price in USD per web search | \ No newline at end of file +| `Audio` | `*string` | :heavy_minus_sign: | Price in USD per audio input token | +| `AudioOutput` | `*string` | :heavy_minus_sign: | Price in USD per audio output token | +| `Completion` | `string` | :heavy_check_mark: | Price in USD per token for completion (output) generation | +| `Discount` | `*float64` | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `Image` | `*string` | :heavy_minus_sign: | Price in USD per input image | +| `ImageOutput` | `*string` | :heavy_minus_sign: | Price in USD per output image | +| `ImageToken` | `*string` | :heavy_minus_sign: | Price in USD per image token | +| `InputAudioCache` | `*string` | :heavy_minus_sign: | Price in USD per cached audio input token | +| `InputCacheRead` | `*string` | :heavy_minus_sign: | Price in USD per cached input token (read) | +| `InputCacheWrite` | `*string` | :heavy_minus_sign: | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | +| `InputCacheWrite1h` | `*string` | :heavy_minus_sign: | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | +| `InternalReasoning` | `*string` | :heavy_minus_sign: | Price in USD per internal reasoning token | +| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride.mdx) | :heavy_minus_sign: | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | +| `Prompt` | `string` | :heavy_check_mark: | Price in USD per token for prompt (input) processing | +| `Request` | `*string` | :heavy_minus_sign: | Price in USD per request | +| `WebSearch` | `*string` | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file diff --git a/docs/models/components/rangecapability.mdx b/docs/models/components/rangecapability.mdx index 041f8cca8..14bda3435 100644 --- a/docs/models/components/rangecapability.mdx +++ b/docs/models/components/rangecapability.mdx @@ -9,6 +9,6 @@ A parameter that accepts any value within an inclusive numeric range. | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Max` | `float64` | ✅ | N/A | -| `Min` | `float64` | ✅ | N/A | -| `Type` | [components.RangeCapabilityType](../../models/components/rangecapabilitytype.mdx) | ✅ | N/A | \ No newline at end of file +| `Max` | `float64` | :heavy_check_mark: | N/A | +| `Min` | `float64` | :heavy_check_mark: | N/A | +| `Type` | [components.RangeCapabilityType](../../models/components/rangecapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/rankingoptions.mdx b/docs/models/components/rankingoptions.mdx index 0acf112f1..0ae1d4473 100644 --- a/docs/models/components/rankingoptions.mdx +++ b/docs/models/components/rankingoptions.mdx @@ -6,5 +6,5 @@ title: "RankingOptions" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Ranker` | [*components.Ranker](../../models/components/ranker.mdx) | ➖ | N/A | -| `ScoreThreshold` | `*float64` | ➖ | N/A | \ No newline at end of file +| `Ranker` | [*components.Ranker](../../models/components/ranker.mdx) | :heavy_minus_sign: | N/A | +| `ScoreThreshold` | `*float64` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/rankingsdailyitem.mdx b/docs/models/components/rankingsdailyitem.mdx index 706723e51..6c3196e4d 100644 --- a/docs/models/components/rankingsdailyitem.mdx +++ b/docs/models/components/rankingsdailyitem.mdx @@ -6,6 +6,6 @@ title: "RankingsDailyItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Date` | `string` | ✅ | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | -| `ModelPermaslug` | `string` | ✅ | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | -| `TotalTokens` | `string` | ✅ | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file +| `Date` | `string` | :heavy_check_mark: | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | +| `TotalTokens` | `string` | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/docs/models/components/rankingsdailymeta.mdx b/docs/models/components/rankingsdailymeta.mdx index f5445091b..969521c40 100644 --- a/docs/models/components/rankingsdailymeta.mdx +++ b/docs/models/components/rankingsdailymeta.mdx @@ -6,7 +6,7 @@ title: "RankingsDailyMeta" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | ✅ | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00:00.000Z | -| `EndDate` | `string` | ✅ | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | -| `StartDate` | `string` | ✅ | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | -| `Version` | [components.RankingsDailyMetaVersion](../../models/components/rankingsdailymetaversion.mdx) | ✅ | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file +| `AsOf` | `string` | :heavy_check_mark: | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00:00.000Z | +| `EndDate` | `string` | :heavy_check_mark: | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | +| `StartDate` | `string` | :heavy_check_mark: | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | +| `Version` | [components.RankingsDailyMetaVersion](../../models/components/rankingsdailymetaversion.mdx) | :heavy_check_mark: | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file diff --git a/docs/models/components/rankingsdailyresponse.mdx b/docs/models/components/rankingsdailyresponse.mdx index cd53d9add..69b871773 100644 --- a/docs/models/components/rankingsdailyresponse.mdx +++ b/docs/models/components/rankingsdailyresponse.mdx @@ -6,5 +6,5 @@ title: "RankingsDailyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.RankingsDailyItem](../../models/components/rankingsdailyitem.mdx) | ✅ | Up to 51 rows per day — the top 50 public models by `total_tokens` for each UTC calendar date in the window, plus one aggregated `other` row summing every model outside that top 50 (omitted when the long tail is empty). Rows are sorted by `date` ascending, then by `total_tokens` descending, with `other` pinned last within its date. Ties between real models break alphabetically on `model_permaslug` so the order is stable across requests. | | -| `Meta` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | ✅ | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `Data` | [][components.RankingsDailyItem](../../models/components/rankingsdailyitem.mdx) | :heavy_check_mark: | Up to 51 rows per day — the top 50 public models by `total_tokens` for each UTC calendar date in the window, plus one aggregated `other` row summing every model outside that top 50 (omitted when the long tail is empty). Rows are sorted by `date` ascending, then by `total_tokens` descending, with `other` pinned last within its date. Ties between real models break alphabetically on `model_permaslug` so the order is stable across requests. | | +| `Meta` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/components/reasoningconfig.mdx b/docs/models/components/reasoningconfig.mdx index 5841935d4..be18c63d1 100644 --- a/docs/models/components/reasoningconfig.mdx +++ b/docs/models/components/reasoningconfig.mdx @@ -6,9 +6,9 @@ title: "ReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext.mdx)] | ➖ | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | -| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | ➖ | N/A | medium | -| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode.mdx)] | ➖ | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | -| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | ➖ | N/A | auto | -| `Enabled` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | \ No newline at end of file +| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext.mdx)] | :heavy_minus_sign: | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | +| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | :heavy_minus_sign: | N/A | medium | +| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode.mdx)] | :heavy_minus_sign: | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | +| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | :heavy_minus_sign: | N/A | auto | +| `Enabled` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdeltaevent.mdx b/docs/models/components/reasoningdeltaevent.mdx index b873f0a17..6d30d8903 100644 --- a/docs/models/components/reasoningdeltaevent.mdx +++ b/docs/models/components/reasoningdeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning text delta is streamed | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | ✅ | N/A | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.ReasoningDeltaEventType](../../models/components/reasoningdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ReasoningDeltaEventType](../../models/components/reasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailencrypted.mdx b/docs/models/components/reasoningdetailencrypted.mdx index 1bc3f1123..29b6a2c11 100644 --- a/docs/models/components/reasoningdetailencrypted.mdx +++ b/docs/models/components/reasoningdetailencrypted.mdx @@ -9,8 +9,8 @@ Reasoning detail encrypted schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | ✅ | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Index` | `*int64` | ➖ | N/A | | -| `Type` | [components.ReasoningDetailEncryptedType](../../models/components/reasoningdetailencryptedtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Index` | `*int64` | :heavy_minus_sign: | N/A | | +| `Type` | [components.ReasoningDetailEncryptedType](../../models/components/reasoningdetailencryptedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailservertoolcall.mdx b/docs/models/components/reasoningdetailservertoolcall.mdx index b170367b3..fbfa24ee1 100644 --- a/docs/models/components/reasoningdetailservertoolcall.mdx +++ b/docs/models/components/reasoningdetailservertoolcall.mdx @@ -9,11 +9,11 @@ Record of an OpenRouter server-tool invocation (e.g. openrouter:fusion), carried | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Arguments` | `string` | ✅ | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Index` | `*int64` | ➖ | N/A | | -| `Result` | `string` | ✅ | N/A | | -| `ToolCallID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ToolName` | `string` | ✅ | N/A | | -| `Type` | [components.ReasoningDetailServerToolCallType](../../models/components/reasoningdetailservertoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Arguments` | `string` | :heavy_check_mark: | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Index` | `*int64` | :heavy_minus_sign: | N/A | | +| `Result` | `string` | :heavy_check_mark: | N/A | | +| `ToolCallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ToolName` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.ReasoningDetailServerToolCallType](../../models/components/reasoningdetailservertoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailsummary.mdx b/docs/models/components/reasoningdetailsummary.mdx index fbc66d186..27d2e923d 100644 --- a/docs/models/components/reasoningdetailsummary.mdx +++ b/docs/models/components/reasoningdetailsummary.mdx @@ -9,8 +9,8 @@ Reasoning detail summary schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Index` | `*int64` | ➖ | N/A | | -| `Summary` | `string` | ✅ | N/A | | -| `Type` | [components.ReasoningDetailSummaryType](../../models/components/reasoningdetailsummarytype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Index` | `*int64` | :heavy_minus_sign: | N/A | | +| `Summary` | `string` | :heavy_check_mark: | N/A | | +| `Type` | [components.ReasoningDetailSummaryType](../../models/components/reasoningdetailsummarytype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailtext.mdx b/docs/models/components/reasoningdetailtext.mdx index 3d0608cce..2a8540c9f 100644 --- a/docs/models/components/reasoningdetailtext.mdx +++ b/docs/models/components/reasoningdetailtext.mdx @@ -9,9 +9,9 @@ Reasoning detail text schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Index` | `*int64` | ➖ | N/A | | -| `Signature` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Text` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Type` | [components.ReasoningDetailTextType](../../models/components/reasoningdetailtexttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Index` | `*int64` | :heavy_minus_sign: | N/A | | +| `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Text` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.ReasoningDetailTextType](../../models/components/reasoningdetailtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdoneevent.mdx b/docs/models/components/reasoningdoneevent.mdx index c1a990496..154d52c52 100644 --- a/docs/models/components/reasoningdoneevent.mdx +++ b/docs/models/components/reasoningdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning text streaming is complete | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.ReasoningDoneEventType](../../models/components/reasoningdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ReasoningDoneEventType](../../models/components/reasoningdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningitem.mdx b/docs/models/components/reasoningitem.mdx index c96f38314..436dee9e7 100644 --- a/docs/models/components/reasoningitem.mdx +++ b/docs/models/components/reasoningitem.mdx @@ -9,11 +9,11 @@ Reasoning output item with signature and format extensions | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | ➖ | N/A | | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `ID` | `string` | ✅ | N/A | | -| `Status` | [*components.ReasoningItemStatusUnion](../../models/components/reasoningitemstatusunion.mdx) | ➖ | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | | -| `Type` | [components.ReasoningItemType](../../models/components/reasoningitemtype.mdx) | ✅ | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | -| `Signature` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [*components.ReasoningItemStatusUnion](../../models/components/reasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ReasoningItemType](../../models/components/reasoningitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarypartaddedevent.mdx b/docs/models/components/reasoningsummarypartaddedevent.mdx index 88e58daae..6b89dae44 100644 --- a/docs/models/components/reasoningsummarypartaddedevent.mdx +++ b/docs/models/components/reasoningsummarypartaddedevent.mdx @@ -9,9 +9,9 @@ Event emitted when a reasoning summary part is added | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | | -| `OutputIndex` | `int64` | ✅ | N/A | | -| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `SummaryIndex` | `int64` | ✅ | N/A | | -| `Type` | [components.ReasoningSummaryPartAddedEventType](../../models/components/reasoningsummarypartaddedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | +| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.ReasoningSummaryPartAddedEventType](../../models/components/reasoningsummarypartaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarypartdoneevent.mdx b/docs/models/components/reasoningsummarypartdoneevent.mdx index a1c758b8a..ef0f09aae 100644 --- a/docs/models/components/reasoningsummarypartdoneevent.mdx +++ b/docs/models/components/reasoningsummarypartdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when a reasoning summary part is complete | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | ✅ | N/A | | -| `OutputIndex` | `int64` | ✅ | N/A | | -| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `SummaryIndex` | `int64` | ✅ | N/A | | -| `Type` | [components.ReasoningSummaryPartDoneEventType](../../models/components/reasoningsummarypartdoneeventtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | +| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.ReasoningSummaryPartDoneEventType](../../models/components/reasoningsummarypartdoneeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytext.mdx b/docs/models/components/reasoningsummarytext.mdx index c5551c16e..209174746 100644 --- a/docs/models/components/reasoningsummarytext.mdx +++ b/docs/models/components/reasoningsummarytext.mdx @@ -6,5 +6,5 @@ title: "ReasoningSummaryText" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.ReasoningSummaryTextType](../../models/components/reasoningsummarytexttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ReasoningSummaryTextType](../../models/components/reasoningsummarytexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytextdeltaevent.mdx b/docs/models/components/reasoningsummarytextdeltaevent.mdx index 79da2425a..f79a9e10c 100644 --- a/docs/models/components/reasoningsummarytextdeltaevent.mdx +++ b/docs/models/components/reasoningsummarytextdeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning summary text delta is streamed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `SummaryIndex` | `int64` | ✅ | N/A | -| `Type` | [components.ReasoningSummaryTextDeltaEventType](../../models/components/reasoningsummarytextdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ReasoningSummaryTextDeltaEventType](../../models/components/reasoningsummarytextdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytextdoneevent.mdx b/docs/models/components/reasoningsummarytextdoneevent.mdx index 1b85d9efc..9692b4b60 100644 --- a/docs/models/components/reasoningsummarytextdoneevent.mdx +++ b/docs/models/components/reasoningsummarytextdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning summary text streaming is complete | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `SummaryIndex` | `int64` | ✅ | N/A | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.ReasoningSummaryTextDoneEventType](../../models/components/reasoningsummarytextdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ReasoningSummaryTextDoneEventType](../../models/components/reasoningsummarytextdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningtextcontent.mdx b/docs/models/components/reasoningtextcontent.mdx index 1037d3ad6..cce8e4aa7 100644 --- a/docs/models/components/reasoningtextcontent.mdx +++ b/docs/models/components/reasoningtextcontent.mdx @@ -6,5 +6,5 @@ title: "ReasoningTextContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.ReasoningTextContentType](../../models/components/reasoningtextcontenttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ReasoningTextContentType](../../models/components/reasoningtextcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/refusal.mdx b/docs/models/components/refusal.mdx index 1aac47f68..fc4089d59 100644 --- a/docs/models/components/refusal.mdx +++ b/docs/models/components/refusal.mdx @@ -6,7 +6,7 @@ title: "Refusal" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | ✅ | N/A | -| `Logprob` | `float64` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | -| `TopLogprobs` | [][components.RefusalTopLogprob](../../models/components/refusaltoplogprob.mdx) | ✅ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_check_mark: | N/A | +| `Logprob` | `float64` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | +| `TopLogprobs` | [][components.RefusalTopLogprob](../../models/components/refusaltoplogprob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/refusaldeltaevent.mdx b/docs/models/components/refusaldeltaevent.mdx index 8c9c2f30f..1a2213c7c 100644 --- a/docs/models/components/refusaldeltaevent.mdx +++ b/docs/models/components/refusaldeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when a refusal delta is streamed | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | ✅ | N/A | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.RefusalDeltaEventType](../../models/components/refusaldeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.RefusalDeltaEventType](../../models/components/refusaldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/refusaldoneevent.mdx b/docs/models/components/refusaldoneevent.mdx index 7c6ab6526..d4eaeff06 100644 --- a/docs/models/components/refusaldoneevent.mdx +++ b/docs/models/components/refusaldoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when refusal streaming is complete | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `Refusal` | `string` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.RefusalDoneEventType](../../models/components/refusaldoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `Refusal` | `string` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.RefusalDoneEventType](../../models/components/refusaldoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/refusaltoplogprob.mdx b/docs/models/components/refusaltoplogprob.mdx index 3436f87c5..fe97c5092 100644 --- a/docs/models/components/refusaltoplogprob.mdx +++ b/docs/models/components/refusaltoplogprob.mdx @@ -6,6 +6,6 @@ title: "RefusalTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | ✅ | N/A | -| `Logprob` | `float64` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_check_mark: | N/A | +| `Logprob` | `float64` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/request.mdx b/docs/models/components/request.mdx index 66c917fba..db171aef5 100644 --- a/docs/models/components/request.mdx +++ b/docs/models/components/request.mdx @@ -6,5 +6,5 @@ title: "Request" | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `Body` | map[string]`any` | ✅ | Request payload for the batch `endpoint`. | -| `CustomID` | `string` | ✅ | N/A | \ No newline at end of file +| `Body` | map[string]`any` | :heavy_check_mark: | Request payload for the batch `endpoint`. | +| `CustomID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/requesttimeoutresponseerrordata.mdx b/docs/models/components/requesttimeoutresponseerrordata.mdx index 2939b6fa3..d49e08c06 100644 --- a/docs/models/components/requesttimeoutresponseerrordata.mdx +++ b/docs/models/components/requesttimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for RequestTimeoutResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/requireapproval.mdx b/docs/models/components/requireapproval.mdx index f926d7023..da9605a26 100644 --- a/docs/models/components/requireapproval.mdx +++ b/docs/models/components/requireapproval.mdx @@ -6,5 +6,5 @@ title: "RequireApproval" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Always` | [*components.Always](../../models/components/always.mdx) | ➖ | N/A | -| `Never` | [*components.Never](../../models/components/never.mdx) | ➖ | N/A | \ No newline at end of file +| `Always` | [*components.Always](../../models/components/always.mdx) | :heavy_minus_sign: | N/A | +| `Never` | [*components.Never](../../models/components/never.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/rerank.mdx b/docs/models/components/rerank.mdx index 86b063287..bea622f31 100644 --- a/docs/models/components/rerank.mdx +++ b/docs/models/components/rerank.mdx @@ -6,6 +6,6 @@ title: "Rerank" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/responsehealingplugin.mdx b/docs/models/components/responsehealingplugin.mdx index b32c47cf5..6ca7b323d 100644 --- a/docs/models/components/responsehealingplugin.mdx +++ b/docs/models/components/responsehealingplugin.mdx @@ -6,5 +6,5 @@ title: "ResponseHealingPlugin" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | ➖ | Set to false to disable the response-healing plugin for this request. Defaults to true. | -| `ID` | [components.ResponseHealingPluginID](../../models/components/responsehealingpluginid.mdx) | ✅ | N/A | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | +| `ID` | [components.ResponseHealingPluginID](../../models/components/responsehealingpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/responseoutputtext.mdx b/docs/models/components/responseoutputtext.mdx index 06ad559e2..41a039c71 100644 --- a/docs/models/components/responseoutputtext.mdx +++ b/docs/models/components/responseoutputtext.mdx @@ -6,7 +6,7 @@ title: "ResponseOutputText" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Annotations` | [][components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | ➖ | N/A | -| `Logprobs` | [][components.Logprob](../../models/components/logprob.mdx) | ➖ | N/A | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.ResponseOutputTextType](../../models/components/responseoutputtexttype.mdx) | ✅ | N/A | \ No newline at end of file +| `Annotations` | [][components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | :heavy_minus_sign: | N/A | +| `Logprobs` | [][components.Logprob](../../models/components/logprob.mdx) | :heavy_minus_sign: | N/A | +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.ResponseOutputTextType](../../models/components/responseoutputtexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/responseoutputtexttoplogprob.mdx b/docs/models/components/responseoutputtexttoplogprob.mdx index 70fbe7cad..ccf5cb7ce 100644 --- a/docs/models/components/responseoutputtexttoplogprob.mdx +++ b/docs/models/components/responseoutputtexttoplogprob.mdx @@ -6,6 +6,6 @@ title: "ResponseOutputTextTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | ✅ | N/A | -| `Logprob` | `float64` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_check_mark: | N/A | +| `Logprob` | `float64` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/responsesrequest.mdx b/docs/models/components/responsesrequest.mdx index 30b22dc43..67c22a533 100644 --- a/docs/models/components/responsesrequest.mdx +++ b/docs/models/components/responsesrequest.mdx @@ -9,42 +9,42 @@ Request schema for Responses endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Background` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Debug` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | -| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | ➖ | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | -| `Include` | optionalnullable.OptionalNullable[[][components.ResponseIncludesEnum](../../models/components/responseincludesenum.mdx)] | ➖ | N/A | | -| `Input` | [*components.InputsUnion](../../models/components/inputsunion.mdx) | ➖ | Input for a response request - can be a string or array of items | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | -| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum number of server-tool (e.g. `openrouter:web_search`) agent steps the model may take during a request. Defaults to 30, which is also the maximum. Ignored when `stop_server_tools_when` is set. | 30 | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`string`] | ➖ | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | -| `Modalities` | [][components.OutputModalityEnum](../../models/components/outputmodalityenum.mdx) | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `Model` | `*string` | ➖ | N/A | | -| `Models` | []`string` | ➖ | N/A | | -| `ParallelToolCalls` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `Plugins` | [][components.ResponsesRequestPlugin](../../models/components/responsesrequestplugin.mdx) | ➖ | Plugins you want to enable for this request, including their settings. | | -| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | -| `PreviousResponseID` | `any` | ➖ | Not supported on this proxy. Each response request is independent: no responses are stored, so a previous response cannot be referenced. Requests with a non-null value are rejected with a 400 error. Send the full conversation history in `input` instead. | | -| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `Reasoning` | optionalnullable.OptionalNullable[[components.ReasoningConfig](../../models/components/reasoningconfig.mdx)] | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | ➖ | Recommended per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | -| `ServiceTier` | optionalnullable.OptionalNullable[[components.ResponsesRequestServiceTier](../../models/components/responsesrequestservicetier.mdx)] | ➖ | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `Store` | `*bool` | ➖ | N/A | | -| `Stream` | `*bool` | ➖ | N/A | | -| `Temperature` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | -| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `ToolChoice` | [*components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | -| `Tools` | [][components.ResponsesRequestToolUnion](../../models/components/responsesrequesttoolunion.mdx) | ➖ | N/A | | -| `TopK` | `*int64` | ➖ | N/A | | -| `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | -| `TopP` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `Truncation` | optionalnullable.OptionalNullable[[components.OpenAIResponsesTruncation](../../models/components/openairesponsestruncation.mdx)] | ➖ | N/A | auto | -| `User` | `*string` | ➖ | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file +| `Background` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Debug` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | +| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | +| `Include` | optionalnullable.OptionalNullable[[][components.ResponseIncludesEnum](../../models/components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | +| `Input` | [*components.InputsUnion](../../models/components/inputsunion.mdx) | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | +| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum number of server-tool (e.g. `openrouter:web_search`) agent steps the model may take during a request. Defaults to 30, which is also the maximum. Ignored when `stop_server_tools_when` is set. | 30 | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | +| `Modalities` | [][components.OutputModalityEnum](../../models/components/outputmodalityenum.mdx) | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `Model` | `*string` | :heavy_minus_sign: | N/A | | +| `Models` | []`string` | :heavy_minus_sign: | N/A | | +| `ParallelToolCalls` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `Plugins` | [][components.ResponsesRequestPlugin](../../models/components/responsesrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | +| `PreviousResponseID` | `any` | :heavy_minus_sign: | Not supported on this proxy. Each response request is independent: no responses are stored, so a previous response cannot be referenced. Requests with a non-null value are rejected with a 400 error. Send the full conversation history in `input` instead. | | +| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `Reasoning` | optionalnullable.OptionalNullable[[components.ReasoningConfig](../../models/components/reasoningconfig.mdx)] | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Recommended per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | +| `ServiceTier` | optionalnullable.OptionalNullable[[components.ResponsesRequestServiceTier](../../models/components/responsesrequestservicetier.mdx)] | :heavy_minus_sign: | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `Store` | `*bool` | :heavy_minus_sign: | N/A | | +| `Stream` | `*bool` | :heavy_minus_sign: | N/A | | +| `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | +| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `ToolChoice` | [*components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | +| `Tools` | [][components.ResponsesRequestToolUnion](../../models/components/responsesrequesttoolunion.mdx) | :heavy_minus_sign: | N/A | | +| `TopK` | `*int64` | :heavy_minus_sign: | N/A | | +| `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | +| `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `Truncation` | optionalnullable.OptionalNullable[[components.OpenAIResponsesTruncation](../../models/components/openairesponsestruncation.mdx)] | :heavy_minus_sign: | N/A | auto | +| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file diff --git a/docs/models/components/responsesrequesttoolfunction.mdx b/docs/models/components/responsesrequesttoolfunction.mdx index e021df93e..a7c560c98 100644 --- a/docs/models/components/responsesrequesttoolfunction.mdx +++ b/docs/models/components/responsesrequesttoolfunction.mdx @@ -9,10 +9,10 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Parameters` | map[string]`any` | ✅ | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `Type` | [components.ResponsesRequestType](../../models/components/responsesrequesttype.mdx) | ✅ | N/A | | -| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.ResponsesRequestType](../../models/components/responsesrequesttype.mdx) | :heavy_check_mark: | N/A | | +| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/components/responsesstreamingresponse.mdx b/docs/models/components/responsesstreamingresponse.mdx index 938e32451..19b424ff7 100644 --- a/docs/models/components/responsesstreamingresponse.mdx +++ b/docs/models/components/responsesstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ResponsesStreamingResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.StreamEvents](../../models/components/streamevents.mdx) | ✅ | Union of all possible event types emitted during response streaming | \{
"response": \{
"completed_at": null,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "in_progress",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null
},
"sequence_number": 0,
"type": "response.created"
} | \ No newline at end of file +| `Data` | [components.StreamEvents](../../models/components/streamevents.mdx) | :heavy_check_mark: | Union of all possible event types emitted during response streaming | \{
"response": \{
"completed_at": null,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "in_progress",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null
},
"sequence_number": 0,
"type": "response.created"
} | \ No newline at end of file diff --git a/docs/models/components/result.mdx b/docs/models/components/result.mdx index 81e3cb179..53310a7bd 100644 --- a/docs/models/components/result.mdx +++ b/docs/models/components/result.mdx @@ -6,7 +6,7 @@ title: "Result" | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `CustomID` | `string` | ✅ | N/A | -| `Error` | [*components.ResultError](../../models/components/resulterror.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Response` | [*components.BatchObjectResponse](../../models/components/batchobjectresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `CustomID` | `string` | :heavy_check_mark: | N/A | +| `Error` | [*components.ResultError](../../models/components/resulterror.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Response` | [*components.BatchObjectResponse](../../models/components/batchobjectresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/resulterror.mdx b/docs/models/components/resulterror.mdx index 869c3b692..73afd94b6 100644 --- a/docs/models/components/resulterror.mdx +++ b/docs/models/components/resulterror.mdx @@ -6,7 +6,7 @@ title: "ResultError" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `Message` | `string` | ✅ | N/A | | -| `Param` | `*string` | ✅ | N/A | | -| `Type` | `string` | ✅ | N/A | | \ No newline at end of file +| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `Message` | `string` | :heavy_check_mark: | N/A | | +| `Param` | `*string` | :heavy_check_mark: | N/A | | +| `Type` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/routerattempt.mdx b/docs/models/components/routerattempt.mdx index d2cff8aa2..0335b6ccf 100644 --- a/docs/models/components/routerattempt.mdx +++ b/docs/models/components/routerattempt.mdx @@ -6,6 +6,6 @@ title: "RouterAttempt" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | ✅ | N/A | -| `Provider` | `string` | ✅ | N/A | -| `Status` | `int64` | ✅ | N/A | \ No newline at end of file +| `Model` | `string` | :heavy_check_mark: | N/A | +| `Provider` | `string` | :heavy_check_mark: | N/A | +| `Status` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/routerparams.mdx b/docs/models/components/routerparams.mdx index 45e2a55dc..538d4b72d 100644 --- a/docs/models/components/routerparams.mdx +++ b/docs/models/components/routerparams.mdx @@ -6,7 +6,7 @@ title: "RouterParams" | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `QualityFloor` | `*float64` | ➖ | N/A | | -| `ThroughputFloor` | `*float64` | ➖ | N/A | | -| `VersionGroup` | `*string` | ➖ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file +| `QualityFloor` | `*float64` | :heavy_minus_sign: | N/A | | +| `ThroughputFloor` | `*float64` | :heavy_minus_sign: | N/A | | +| `VersionGroup` | `*string` | :heavy_minus_sign: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file diff --git a/docs/models/components/rule.mdx b/docs/models/components/rule.mdx index 60fcf3324..5f0969ebf 100644 --- a/docs/models/components/rule.mdx +++ b/docs/models/components/rule.mdx @@ -6,6 +6,6 @@ title: "Rule" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Field` | [components.Field](../../models/components/field.mdx) | ✅ | N/A | -| `Operator` | [components.Operator](../../models/components/operator.mdx) | ✅ | N/A | -| `Value` | [*components.ObservabilityFilterRuleGroupValue](../../models/components/observabilityfilterrulegroupvalue.mdx) | ➖ | N/A | \ No newline at end of file +| `Field` | [components.Field](../../models/components/field.mdx) | :heavy_check_mark: | N/A | +| `Operator` | [components.Operator](../../models/components/operator.mdx) | :heavy_check_mark: | N/A | +| `Value` | [*components.ObservabilityFilterRuleGroupValue](../../models/components/observabilityfilterrulegroupvalue.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/scimgroup.mdx b/docs/models/components/scimgroup.mdx index b20ed17b5..5d9ced078 100644 --- a/docs/models/components/scimgroup.mdx +++ b/docs/models/components/scimgroup.mdx @@ -6,9 +6,9 @@ title: "ScimGroup" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `CreatedAt` | `string` | ✅ | N/A | -| `DisplayName` | `string` | ✅ | N/A | -| `ExternalID` | `*string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `OrganizationID` | `string` | ✅ | N/A | -| `UpdatedAt` | `string` | ✅ | N/A | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | N/A | +| `DisplayName` | `string` | :heavy_check_mark: | N/A | +| `ExternalID` | `*string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `OrganizationID` | `string` | :heavy_check_mark: | N/A | +| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/scimgroupmapping.mdx b/docs/models/components/scimgroupmapping.mdx index 5e8846fb2..3d314dd09 100644 --- a/docs/models/components/scimgroupmapping.mdx +++ b/docs/models/components/scimgroupmapping.mdx @@ -6,10 +6,10 @@ title: "ScimGroupMapping" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `OrganizationID` | `string` | ✅ | N/A | -| `Role` | [components.ScimGroupMappingRole](../../models/components/scimgroupmappingrole.mdx) | ✅ | N/A | -| `ScimGroupID` | `string` | ✅ | N/A | -| `UpdatedAt` | `string` | ✅ | N/A | -| `WorkspaceID` | `string` | ✅ | N/A | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `OrganizationID` | `string` | :heavy_check_mark: | N/A | +| `Role` | [components.ScimGroupMappingRole](../../models/components/scimgroupmappingrole.mdx) | :heavy_check_mark: | N/A | +| `ScimGroupID` | `string` | :heavy_check_mark: | N/A | +| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | +| `WorkspaceID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/scimsyncjob.mdx b/docs/models/components/scimsyncjob.mdx index 1578d9ab2..4815f0cc9 100644 --- a/docs/models/components/scimsyncjob.mdx +++ b/docs/models/components/scimsyncjob.mdx @@ -6,11 +6,11 @@ title: "ScimSyncJob" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `CreatedAt` | `string` | ✅ | Time when the sync job was created. | -| `DeletedGroups` | `*int64` | ✅ | Number of groups deleted, when the job completed successfully. | -| `ErrorMessage` | `*string` | ✅ | Stable error message when the job failed. | -| `FinishedAt` | `*string` | ✅ | Time when synchronization finished. | -| `ID` | `string` | ✅ | Unique identifier for the sync job. | -| `StartedAt` | `*string` | ✅ | Time when synchronization started. | -| `Status` | [components.ScimSyncJobStatus](../../models/components/scimsyncjobstatus.mdx) | ✅ | Current status of the sync job: queued, running, succeeded, or failed. | -| `SyncedGroups` | `*int64` | ✅ | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | Time when the sync job was created. | +| `DeletedGroups` | `*int64` | :heavy_check_mark: | Number of groups deleted, when the job completed successfully. | +| `ErrorMessage` | `*string` | :heavy_check_mark: | Stable error message when the job failed. | +| `FinishedAt` | `*string` | :heavy_check_mark: | Time when synchronization finished. | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the sync job. | +| `StartedAt` | `*string` | :heavy_check_mark: | Time when synchronization started. | +| `Status` | [components.ScimSyncJobStatus](../../models/components/scimsyncjobstatus.mdx) | :heavy_check_mark: | Current status of the sync job: queued, running, succeeded, or failed. | +| `SyncedGroups` | `*int64` | :heavy_check_mark: | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file diff --git a/docs/models/components/searchmodelsservertoolconfig.mdx b/docs/models/components/searchmodelsservertoolconfig.mdx index 7e3f9d02a..cbde7e888 100644 --- a/docs/models/components/searchmodelsservertoolconfig.mdx +++ b/docs/models/components/searchmodelsservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:experimental__search_models server tool | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `MaxResults` | `*int64` | ➖ | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file diff --git a/docs/models/components/searchmodelsservertoolopenrouter.mdx b/docs/models/components/searchmodelsservertoolopenrouter.mdx index 304390773..29bb89eba 100644 --- a/docs/models/components/searchmodelsservertoolopenrouter.mdx +++ b/docs/models/components/searchmodelsservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.SearchModelsServerToolOpenRouterType](../../models/components/searchmodelsservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.SearchModelsServerToolOpenRouterType](../../models/components/searchmodelsservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/security.mdx b/docs/models/components/security.mdx index 8801243a1..8015ad3c4 100644 --- a/docs/models/components/security.mdx +++ b/docs/models/components/security.mdx @@ -6,4 +6,4 @@ title: "Security" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `APIKey` | `*string` | ➖ | N/A | \ No newline at end of file +| `APIKey` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/servertool.mdx b/docs/models/components/servertool.mdx index b3997b2df..1728fb988 100644 --- a/docs/models/components/servertool.mdx +++ b/docs/models/components/servertool.mdx @@ -6,18 +6,18 @@ title: "ServerTool" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Aliases` | [][components.ServerToolInputName](../../models/components/servertoolinputname.mdx) | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | -| `DefaultEngine` | `*string` | ✅ | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | -| `DocsURL` | `string` | ✅ | N/A | | -| `Engines` | [][components.ServerToolEngine](../../models/components/servertoolengine.mdx) | ✅ | N/A | | -| `FallbackEngine` | `*string` | ✅ | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | -| `ID` | `string` | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `InputSchema` | map[string]`any` | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `Name` | `string` | ✅ | N/A | Web search | -| `NativeSupport` | [components.ServerToolNativeSupport](../../models/components/servertoolnativesupport.mdx) | ✅ | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | -| `OutputSchema` | map[string]`any` | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `ParametersSchema` | map[string]`any` | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `Status` | [components.ServerToolStatus](../../models/components/servertoolstatus.mdx) | ✅ | N/A | active | -| `Summary` | `string` | ✅ | One sentence for cards and search results; never sent to a model | | -| `SupportedAPIFormats` | [][components.ServerToolSupportedAPIFormat](../../models/components/servertoolsupportedapiformat.mdx) | ✅ | N/A | | -| `ToolDescription` | `string` | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file +| `Aliases` | [][components.ServerToolInputName](../../models/components/servertoolinputname.mdx) | :heavy_check_mark: | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | +| `DefaultEngine` | `*string` | :heavy_check_mark: | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | +| `DocsURL` | `string` | :heavy_check_mark: | N/A | | +| `Engines` | [][components.ServerToolEngine](../../models/components/servertoolengine.mdx) | :heavy_check_mark: | N/A | | +| `FallbackEngine` | `*string` | :heavy_check_mark: | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | +| `ID` | `string` | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `InputSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `Name` | `string` | :heavy_check_mark: | N/A | Web search | +| `NativeSupport` | [components.ServerToolNativeSupport](../../models/components/servertoolnativesupport.mdx) | :heavy_check_mark: | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | +| `OutputSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `ParametersSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `Status` | [components.ServerToolStatus](../../models/components/servertoolstatus.mdx) | :heavy_check_mark: | N/A | active | +| `Summary` | `string` | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | +| `SupportedAPIFormats` | [][components.ServerToolSupportedAPIFormat](../../models/components/servertoolsupportedapiformat.mdx) | :heavy_check_mark: | N/A | | +| `ToolDescription` | `string` | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/models/components/servertooldetails.mdx b/docs/models/components/servertooldetails.mdx index 2881f17dd..57eccdd99 100644 --- a/docs/models/components/servertooldetails.mdx +++ b/docs/models/components/servertooldetails.mdx @@ -6,18 +6,18 @@ title: "ServerToolDetails" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Aliases` | [][components.ServerToolInputName](../../models/components/servertoolinputname.mdx) | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | -| `DefaultEngine` | `*string` | ✅ | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | -| `DocsURL` | `string` | ✅ | N/A | | -| `Engines` | [][components.ServerToolEngine](../../models/components/servertoolengine.mdx) | ✅ | N/A | | -| `FallbackEngine` | `*string` | ✅ | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | -| `ID` | `string` | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `InputSchema` | map[string]`any` | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `Name` | `string` | ✅ | N/A | Web search | -| `NativeSupport` | [components.NativeSupport](../../models/components/nativesupport.mdx) | ✅ | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | -| `OutputSchema` | map[string]`any` | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `ParametersSchema` | map[string]`any` | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `Status` | [components.ServerToolDetailsStatus](../../models/components/servertooldetailsstatus.mdx) | ✅ | N/A | active | -| `Summary` | `string` | ✅ | One sentence for cards and search results; never sent to a model | | -| `SupportedAPIFormats` | [][components.ServerToolDetailsSupportedAPIFormat](../../models/components/servertooldetailssupportedapiformat.mdx) | ✅ | N/A | | -| `ToolDescription` | `string` | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file +| `Aliases` | [][components.ServerToolInputName](../../models/components/servertoolinputname.mdx) | :heavy_check_mark: | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | +| `DefaultEngine` | `*string` | :heavy_check_mark: | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | +| `DocsURL` | `string` | :heavy_check_mark: | N/A | | +| `Engines` | [][components.ServerToolEngine](../../models/components/servertoolengine.mdx) | :heavy_check_mark: | N/A | | +| `FallbackEngine` | `*string` | :heavy_check_mark: | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | +| `ID` | `string` | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `InputSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `Name` | `string` | :heavy_check_mark: | N/A | Web search | +| `NativeSupport` | [components.NativeSupport](../../models/components/nativesupport.mdx) | :heavy_check_mark: | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | +| `OutputSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `ParametersSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `Status` | [components.ServerToolDetailsStatus](../../models/components/servertooldetailsstatus.mdx) | :heavy_check_mark: | N/A | active | +| `Summary` | `string` | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | +| `SupportedAPIFormats` | [][components.ServerToolDetailsSupportedAPIFormat](../../models/components/servertooldetailssupportedapiformat.mdx) | :heavy_check_mark: | N/A | | +| `ToolDescription` | `string` | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/models/components/servertoolengine.mdx b/docs/models/components/servertoolengine.mdx index 1c5931a5b..153d0301a 100644 --- a/docs/models/components/servertoolengine.mdx +++ b/docs/models/components/servertoolengine.mdx @@ -6,12 +6,12 @@ title: "ServerToolEngine" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOK` | [components.BYOK](../../models/components/byok.mdx) | ✅ | Whether the engine needs the caller's own key, saved in plugin settings: `required` (OpenRouter holds none), `optional` (OpenRouter's key is used unless the caller saved one), or `none` | none | -| `DataRegions` | [][components.ServerToolEngineDataRegion](../../models/components/servertoolenginedataregion.mdx) | ✅ | The data regions whose requests this engine serves without leaving the region. A request pinned to a region can only use engines that list it; `global` is always listed. | [
"global",
"us"
] | -| `DefaultMode` | `*string` | ✅ | The `parameters.mode` a request without one runs and bills as; null for engines without modes. The `pricing[]` row with this `mode` is what an unmoded request bills | auto | -| `ExecutedBy` | [components.ServerToolExecutedBy](../../models/components/servertoolexecutedby.mdx) | ✅ | Who runs the tool call: the model provider during inference (`provider`), OpenRouter (`openrouter`), or the caller's application after the call is returned (`client`). | openrouter | -| `ID` | `*string` | ✅ | The `parameters.engine` value that selects this engine; null for the single engine of a tool without an engine parameter | exa | -| `Name` | `string` | ✅ | N/A | Exa | -| `Pricing` | [][components.ServerToolPrice](../../models/components/servertoolprice.mdx) | ✅ | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | -| `PricingDocURL` | `*string` | ✅ | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | -| `PricingSource` | [components.PricingSource](../../models/components/pricingsource.mdx) | ✅ | Who bills the engine's calls beyond the model's tokens: `openrouter` (the `pricing` rows, from the caller's credits), `provider` (a per-call tool fee from the model's provider on the inference call, at its own rates), `byok` (the engine's vendor, against the caller's own key), or `none` (no charge) | openrouter | \ No newline at end of file +| `BYOK` | [components.BYOK](../../models/components/byok.mdx) | :heavy_check_mark: | Whether the engine needs the caller's own key, saved in plugin settings: `required` (OpenRouter holds none), `optional` (OpenRouter's key is used unless the caller saved one), or `none` | none | +| `DataRegions` | [][components.ServerToolEngineDataRegion](../../models/components/servertoolenginedataregion.mdx) | :heavy_check_mark: | The data regions whose requests this engine serves without leaving the region. A request pinned to a region can only use engines that list it; `global` is always listed. | [
"global",
"us"
] | +| `DefaultMode` | `*string` | :heavy_check_mark: | The `parameters.mode` a request without one runs and bills as; null for engines without modes. The `pricing[]` row with this `mode` is what an unmoded request bills | auto | +| `ExecutedBy` | [components.ServerToolExecutedBy](../../models/components/servertoolexecutedby.mdx) | :heavy_check_mark: | Who runs the tool call: the model provider during inference (`provider`), OpenRouter (`openrouter`), or the caller's application after the call is returned (`client`). | openrouter | +| `ID` | `*string` | :heavy_check_mark: | The `parameters.engine` value that selects this engine; null for the single engine of a tool without an engine parameter | exa | +| `Name` | `string` | :heavy_check_mark: | N/A | Exa | +| `Pricing` | [][components.ServerToolPrice](../../models/components/servertoolprice.mdx) | :heavy_check_mark: | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | +| `PricingDocURL` | `*string` | :heavy_check_mark: | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | +| `PricingSource` | [components.PricingSource](../../models/components/pricingsource.mdx) | :heavy_check_mark: | Who bills the engine's calls beyond the model's tokens: `openrouter` (the `pricing` rows, from the caller's credits), `provider` (a per-call tool fee from the model's provider on the inference call, at its own rates), `byok` (the engine's vendor, against the caller's own key), or `none` (no charge) | openrouter | \ No newline at end of file diff --git a/docs/models/components/servertoolinputname.mdx b/docs/models/components/servertoolinputname.mdx index 72b810202..0092ef47e 100644 --- a/docs/models/components/servertoolinputname.mdx +++ b/docs/models/components/servertoolinputname.mdx @@ -6,6 +6,6 @@ title: "ServerToolInputName" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIFormats` | [][components.ServerToolInputNameAPIFormat](../../models/components/servertoolinputnameapiformat.mdx) | ✅ | API formats that accept this spelling in `tools[].type` | | -| `OutputNames` | [][components.ServerToolOutputName](../../models/components/servertooloutputname.mdx) | ✅ | What the call surfaces as on each accepting API format when requested under this spelling; a format is absent when the call is not visible to the caller | | -| `Type` | `string` | ✅ | N/A | web_search_20250305 | \ No newline at end of file +| `APIFormats` | [][components.ServerToolInputNameAPIFormat](../../models/components/servertoolinputnameapiformat.mdx) | :heavy_check_mark: | API formats that accept this spelling in `tools[].type` | | +| `OutputNames` | [][components.ServerToolOutputName](../../models/components/servertooloutputname.mdx) | :heavy_check_mark: | What the call surfaces as on each accepting API format when requested under this spelling; a format is absent when the call is not visible to the caller | | +| `Type` | `string` | :heavy_check_mark: | N/A | web_search_20250305 | \ No newline at end of file diff --git a/docs/models/components/servertoolnativemodel.mdx b/docs/models/components/servertoolnativemodel.mdx index 32ad2ac70..d1184a9ae 100644 --- a/docs/models/components/servertoolnativemodel.mdx +++ b/docs/models/components/servertoolnativemodel.mdx @@ -6,5 +6,5 @@ title: "ServerToolNativeModel" | Field | Type | Required | Description | Example | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `Providers` | []`string` | ✅ | N/A | [
"Anthropic",
"Google"
] | -| `Slug` | `string` | ✅ | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file +| `Providers` | []`string` | :heavy_check_mark: | N/A | [
"Anthropic",
"Google"
] | +| `Slug` | `string` | :heavy_check_mark: | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file diff --git a/docs/models/components/servertoolnativesupport.mdx b/docs/models/components/servertoolnativesupport.mdx index c47ef8e64..a99eb2c60 100644 --- a/docs/models/components/servertoolnativesupport.mdx +++ b/docs/models/components/servertoolnativesupport.mdx @@ -9,5 +9,5 @@ Endpoints whose provider runs this tool itself during inference. Zero for tools | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `EndpointCount` | `int64` | ✅ | N/A | 18 | -| `ModelCount` | `int64` | ✅ | N/A | 12 | \ No newline at end of file +| `EndpointCount` | `int64` | :heavy_check_mark: | N/A | 18 | +| `ModelCount` | `int64` | :heavy_check_mark: | N/A | 12 | \ No newline at end of file diff --git a/docs/models/components/servertooloutputname.mdx b/docs/models/components/servertooloutputname.mdx index d6dd649e7..91081a7ef 100644 --- a/docs/models/components/servertooloutputname.mdx +++ b/docs/models/components/servertooloutputname.mdx @@ -6,6 +6,6 @@ title: "ServerToolOutputName" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `APIFormat` | [components.ServerToolOutputNameAPIFormat](../../models/components/servertooloutputnameapiformat.mdx) | ✅ | N/A | | -| `Name` | `*string` | ➖ | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | -| `Type` | `string` | ✅ | Output item `type` on Responses, content block `type` on Anthropic Messages, `reasoning_details[].type` on Chat Completions | web_search_call | \ No newline at end of file +| `APIFormat` | [components.ServerToolOutputNameAPIFormat](../../models/components/servertooloutputnameapiformat.mdx) | :heavy_check_mark: | N/A | | +| `Name` | `*string` | :heavy_minus_sign: | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | +| `Type` | `string` | :heavy_check_mark: | Output item `type` on Responses, content block `type` on Anthropic Messages, `reasoning_details[].type` on Chat Completions | web_search_call | \ No newline at end of file diff --git a/docs/models/components/servertoolprice.mdx b/docs/models/components/servertoolprice.mdx index 5557c1b23..1a81fcea2 100644 --- a/docs/models/components/servertoolprice.mdx +++ b/docs/models/components/servertoolprice.mdx @@ -6,7 +6,7 @@ title: "ServerToolPrice" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `MaxUnitsPerCall` | `int64` | ✅ | N/A | | -| `Mode` | `*string` | ✅ | The `parameters.mode` this price applies to; null for prices that do not depend on the mode. A request bills exactly one `request` row | auto | -| `Price` | `string` | ✅ | USD per unit, as a decimal string | 0.007 | -| `Unit` | `string` | ✅ | N/A | request | \ No newline at end of file +| `MaxUnitsPerCall` | `int64` | :heavy_check_mark: | N/A | | +| `Mode` | `*string` | :heavy_check_mark: | The `parameters.mode` this price applies to; null for prices that do not depend on the mode. A request bills exactly one `request` row | auto | +| `Price` | `string` | :heavy_check_mark: | USD per unit, as a decimal string | 0.007 | +| `Unit` | `string` | :heavy_check_mark: | N/A | request | \ No newline at end of file diff --git a/docs/models/components/servertoolusedetails.mdx b/docs/models/components/servertoolusedetails.mdx index e8da62873..3d5736d6c 100644 --- a/docs/models/components/servertoolusedetails.mdx +++ b/docs/models/components/servertoolusedetails.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/serviceunavailableresponseerrordata.mdx b/docs/models/components/serviceunavailableresponseerrordata.mdx index 38f12700d..84bfea1cd 100644 --- a/docs/models/components/serviceunavailableresponseerrordata.mdx +++ b/docs/models/components/serviceunavailableresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ServiceUnavailableResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/sessioncostitem.mdx b/docs/models/components/sessioncostitem.mdx index b255e16b9..473fd6fc6 100644 --- a/docs/models/components/sessioncostitem.mdx +++ b/docs/models/components/sessioncostitem.mdx @@ -6,8 +6,8 @@ title: "SessionCostItem" | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `AppName` | `string` | ✅ | Published harness display label. | Hermes Agent | -| `AppSlug` | `string` | ✅ | Stable public slug of the harness. | hermes-agent | -| `MedianSessionCostUsd` | `float64` | ✅ | Median USD spend per sampled session. | 1.74 | -| `ModelPermaslug` | `string` | ✅ | Exact model permaslug. | anthropic/claude-4.8-opus | -| `TurnRange` | [components.TurnRange](../../models/components/turnrange.mdx) | ✅ | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file +| `AppName` | `string` | :heavy_check_mark: | Published harness display label. | Hermes Agent | +| `AppSlug` | `string` | :heavy_check_mark: | Stable public slug of the harness. | hermes-agent | +| `MedianSessionCostUsd` | `float64` | :heavy_check_mark: | Median USD spend per sampled session. | 1.74 | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Exact model permaslug. | anthropic/claude-4.8-opus | +| `TurnRange` | [components.TurnRange](../../models/components/turnrange.mdx) | :heavy_check_mark: | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file diff --git a/docs/models/components/sessioncostmeta.mdx b/docs/models/components/sessioncostmeta.mdx index 8c8480e48..2d3e356d2 100644 --- a/docs/models/components/sessioncostmeta.mdx +++ b/docs/models/components/sessioncostmeta.mdx @@ -6,7 +6,7 @@ title: "SessionCostMeta" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | ✅ | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | -| `Version` | [components.SessionCostMetaVersion](../../models/components/sessioncostmetaversion.mdx) | ✅ | Dataset version. | | -| `WindowDays` | `*int64` | ✅ | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | -| `WindowEndDate` | `*string` | ✅ | UTC date of the final day in the session sample window, or null when no snapshot is published. | 2026-05-11 | \ No newline at end of file +| `AsOf` | `string` | :heavy_check_mark: | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | +| `Version` | [components.SessionCostMetaVersion](../../models/components/sessioncostmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | +| `WindowDays` | `*int64` | :heavy_check_mark: | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | +| `WindowEndDate` | `*string` | :heavy_check_mark: | UTC date of the final day in the session sample window, or null when no snapshot is published. | 2026-05-11 | \ No newline at end of file diff --git a/docs/models/components/sessioncostresponse.mdx b/docs/models/components/sessioncostresponse.mdx index 71a436e3e..20cc06fe3 100644 --- a/docs/models/components/sessioncostresponse.mdx +++ b/docs/models/components/sessioncostresponse.mdx @@ -6,5 +6,5 @@ title: "SessionCostResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Data` | [][components.SessionCostItem](../../models/components/sessioncostitem.mdx) | ✅ | N/A | -| `Meta` | [components.SessionCostMeta](../../models/components/sessioncostmeta.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.SessionCostItem](../../models/components/sessioncostitem.mdx) | :heavy_check_mark: | N/A | +| `Meta` | [components.SessionCostMeta](../../models/components/sessioncostmeta.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/shellcallitem.mdx b/docs/models/components/shellcallitem.mdx index f4266f6e5..8d477bc35 100644 --- a/docs/models/components/shellcallitem.mdx +++ b/docs/models/components/shellcallitem.mdx @@ -9,10 +9,10 @@ A shell command execution call (newer variant) | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ShellCallItemAction](../../models/components/shellcallitemaction.mdx) | ✅ | N/A | | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | -| `CallID` | `string` | ✅ | N/A | | -| `Environment` | `any` | ➖ | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | -| `Type` | [components.ShellCallItemType](../../models/components/shellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Action` | [components.ShellCallItemAction](../../models/components/shellcallitemaction.mdx) | :heavy_check_mark: | N/A | | +| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `Environment` | `any` | :heavy_minus_sign: | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.ShellCallItemType](../../models/components/shellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/shellcallitemaction.mdx b/docs/models/components/shellcallitemaction.mdx index 8bdbd9834..d982453e6 100644 --- a/docs/models/components/shellcallitemaction.mdx +++ b/docs/models/components/shellcallitemaction.mdx @@ -6,6 +6,6 @@ title: "ShellCallItemAction" | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `Commands` | []`string` | ✅ | N/A | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | -| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | \ No newline at end of file +| `Commands` | []`string` | :heavy_check_mark: | N/A | +| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | +| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/shellcalloutputcontent.mdx b/docs/models/components/shellcalloutputcontent.mdx index 605e929b2..db2108e40 100644 --- a/docs/models/components/shellcalloutputcontent.mdx +++ b/docs/models/components/shellcalloutputcontent.mdx @@ -9,7 +9,7 @@ Captured stdout and stderr for one command of a shell call, with its exit or tim | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Outcome` | [components.Outcome](../../models/components/outcome.mdx) | ✅ | N/A | | -| `Stderr` | `string` | ✅ | N/A | | -| `Stdout` | `string` | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"outcome": \{
"exit_code": 0,
"type": "exit"
},
"stderr": "",
"stdout": "total 0\n"
} | \ No newline at end of file +| `Outcome` | [components.Outcome](../../models/components/outcome.mdx) | :heavy_check_mark: | N/A | | +| `Stderr` | `string` | :heavy_check_mark: | N/A | | +| `Stdout` | `string` | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"outcome": \{
"exit_code": 0,
"type": "exit"
},
"stderr": "",
"stdout": "total 0\n"
} | \ No newline at end of file diff --git a/docs/models/components/shellcalloutputitem.mdx b/docs/models/components/shellcalloutputitem.mdx index 729a14711..be6a3f99f 100644 --- a/docs/models/components/shellcalloutputitem.mdx +++ b/docs/models/components/shellcalloutputitem.mdx @@ -9,12 +9,12 @@ Output from a shell command execution (newer variant) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | ✅ | N/A | | -| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `Error` | `*string` | ➖ | The error message when the sandbox call failed before producing a result, as echoed from a failed `shell_call_output` emission. | | -| `Files` | [][components.ShellCallOutputItemFile](../../models/components/shellcalloutputitemfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | -| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | ✅ | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | -| `Type` | [components.ShellCallOutputItemTypeShellCallOutput](../../models/components/shellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | | +| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `Error` | `*string` | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result, as echoed from a failed `shell_call_output` emission. | | +| `Files` | [][components.ShellCallOutputItemFile](../../models/components/shellcalloutputitemfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | +| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | :heavy_check_mark: | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.ShellCallOutputItemTypeShellCallOutput](../../models/components/shellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/shellcalloutputitemfile.mdx b/docs/models/components/shellcalloutputitemfile.mdx index 13b9e14d6..36662824e 100644 --- a/docs/models/components/shellcalloutputitemfile.mdx +++ b/docs/models/components/shellcalloutputitemfile.mdx @@ -6,9 +6,9 @@ title: "ShellCallOutputItemFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `FileID` | `string` | ✅ | N/A | -| `Filename` | `string` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Type` | [components.ShellCallOutputItemTypeContainerFileCitation](../../models/components/shellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `FileID` | `string` | :heavy_check_mark: | N/A | +| `Filename` | `string` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ShellCallOutputItemTypeContainerFileCitation](../../models/components/shellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/shellservertool.mdx b/docs/models/components/shellservertool.mdx index c38b68ebb..951638529 100644 --- a/docs/models/components/shellservertool.mdx +++ b/docs/models/components/shellservertool.mdx @@ -9,4 +9,4 @@ Shell tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.ShellServerToolType](../../models/components/shellservertooltype.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.ShellServerToolType](../../models/components/shellservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/shellservertoolconfig.mdx b/docs/models/components/shellservertoolconfig.mdx index c080ba848..9c2a6b2c1 100644 --- a/docs/models/components/shellservertoolconfig.mdx +++ b/docs/models/components/shellservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:shell server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.ShellServerToolEngine](../../models/components/shellservertoolengine.mdx) | ➖ | Which shell engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) keeps the provider's native hosted shell when available (OpenAI); on other providers the call is routed to the OpenRouter sandbox. | openrouter | -| `Environment` | [*components.ShellServerToolEnvironment](../../models/components/shellservertoolenvironment.mdx) | ➖ | Server-side execution environment for the shell tool. Only container-backed environments are supported; "local" shells are not. | \{
"type": "container_auto"
} | \ No newline at end of file +| `Engine` | [*components.ShellServerToolEngine](../../models/components/shellservertoolengine.mdx) | :heavy_minus_sign: | Which shell engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) keeps the provider's native hosted shell when available (OpenAI); on other providers the call is routed to the OpenRouter sandbox. | openrouter | +| `Environment` | [*components.ShellServerToolEnvironment](../../models/components/shellservertoolenvironment.mdx) | :heavy_minus_sign: | Server-side execution environment for the shell tool. Only container-backed environments are supported; "local" shells are not. | \{
"type": "container_auto"
} | \ No newline at end of file diff --git a/docs/models/components/shellservertoolopenrouter.mdx b/docs/models/components/shellservertoolopenrouter.mdx index d620c11b5..33674ea7a 100644 --- a/docs/models/components/shellservertoolopenrouter.mdx +++ b/docs/models/components/shellservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: runs shell commands server-side in a sandboxed | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ShellServerToolConfig](../../models/components/shellservertoolconfig.mdx) | ➖ | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | -| `Type` | [components.ShellServerToolOpenRouterType](../../models/components/shellservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.ShellServerToolConfig](../../models/components/shellservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | +| `Type` | [components.ShellServerToolOpenRouterType](../../models/components/shellservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/signinterndaemonrequest.mdx b/docs/models/components/signinterndaemonrequest.mdx index 645a2870e..2626f282a 100644 --- a/docs/models/components/signinterndaemonrequest.mdx +++ b/docs/models/components/signinterndaemonrequest.mdx @@ -6,4 +6,4 @@ title: "SignInternDaemonRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `BodySha256` | `string` | ✅ | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | \ No newline at end of file +| `BodySha256` | `string` | :heavy_check_mark: | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | \ No newline at end of file diff --git a/docs/models/components/signinterndaemonresponse.mdx b/docs/models/components/signinterndaemonresponse.mdx index 64bbc1256..235af92d3 100644 --- a/docs/models/components/signinterndaemonresponse.mdx +++ b/docs/models/components/signinterndaemonresponse.mdx @@ -9,6 +9,6 @@ Headers the CLI copies onto the daemon request so the sidecar can verify who is | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `XOriInvokeSignature` | `string` | ✅ | Base64 Ed25519 signature over the intern id, timestamp, user and body digest. | -| `XOriInvokeTimestamp` | `string` | ✅ | Unix seconds at signing; the daemon refuses proofs older than its window. | -| `XOriInvokeUser` | `string` | ✅ | The verified OAuth subject the proof names. Never taken from the request. | \ No newline at end of file +| `XOriInvokeSignature` | `string` | :heavy_check_mark: | Base64 Ed25519 signature over the intern id, timestamp, user and body digest. | +| `XOriInvokeTimestamp` | `string` | :heavy_check_mark: | Unix seconds at signing; the daemon refuses proofs older than its window. | +| `XOriInvokeUser` | `string` | :heavy_check_mark: | The verified OAuth subject the proof names. Never taken from the request. | \ No newline at end of file diff --git a/docs/models/components/sourcecontent.mdx b/docs/models/components/sourcecontent.mdx index 80e60771e..d471d9606 100644 --- a/docs/models/components/sourcecontent.mdx +++ b/docs/models/components/sourcecontent.mdx @@ -6,5 +6,5 @@ title: "SourceContent" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicDocumentBlockParamContent2](../../models/components/anthropicdocumentblockparamcontent2.mdx) | ✅ | N/A | -| `Type` | [components.SourceType](../../models/components/sourcetype.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [components.AnthropicDocumentBlockParamContent2](../../models/components/anthropicdocumentblockparamcontent2.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.SourceType](../../models/components/sourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/speechinputreferenceaudio.mdx b/docs/models/components/speechinputreferenceaudio.mdx index ddd8625bc..c2bbb82ba 100644 --- a/docs/models/components/speechinputreferenceaudio.mdx +++ b/docs/models/components/speechinputreferenceaudio.mdx @@ -9,5 +9,5 @@ Reference audio input for stateless voice cloning. Up to three parts per request | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `InputAudio` | [components.SpeechInputReferenceAudioInput](../../models/components/speechinputreferenceaudioinput.mdx) | ✅ | Reference audio input object | -| `Type` | [components.SpeechInputReferenceAudioType](../../models/components/speechinputreferenceaudiotype.mdx) | ✅ | N/A | \ No newline at end of file +| `InputAudio` | [components.SpeechInputReferenceAudioInput](../../models/components/speechinputreferenceaudioinput.mdx) | :heavy_check_mark: | Reference audio input object | +| `Type` | [components.SpeechInputReferenceAudioType](../../models/components/speechinputreferenceaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/speechinputreferenceaudioinput.mdx b/docs/models/components/speechinputreferenceaudioinput.mdx index 8ebc57809..1dcc1498a 100644 --- a/docs/models/components/speechinputreferenceaudioinput.mdx +++ b/docs/models/components/speechinputreferenceaudioinput.mdx @@ -9,6 +9,6 @@ Reference audio input object | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | `*string` | ➖ | Base64-encoded reference audio (optionally a data URI). Supported audio formats are provider-specific. Limited to 20 MiB of base64 (15 MiB of decoded audio). Exactly one of `data` or `url` is required. | data:audio/wav;base64,UklGRuQXDABXQVZF... | -| `Format` | `*string` | ➖ | Audio format of the reference audio (e.g., wav, mp3). Optional; most providers detect the format from the audio bytes. | wav | -| `URL` | `*string` | ➖ | Public http(s) URL of the reference audio. OpenRouter downloads it (15 MiB max) and forwards the bytes, never the URL. Exactly one of `data` or `url` is required. | https://example.com/reference.wav | \ No newline at end of file +| `Data` | `*string` | :heavy_minus_sign: | Base64-encoded reference audio (optionally a data URI). Supported audio formats are provider-specific. Limited to 20 MiB of base64 (15 MiB of decoded audio). Exactly one of `data` or `url` is required. | data:audio/wav;base64,UklGRuQXDABXQVZF... | +| `Format` | `*string` | :heavy_minus_sign: | Audio format of the reference audio (e.g., wav, mp3). Optional; most providers detect the format from the audio bytes. | wav | +| `URL` | `*string` | :heavy_minus_sign: | Public http(s) URL of the reference audio. OpenRouter downloads it (15 MiB max) and forwards the bytes, never the URL. Exactly one of `data` or `url` is required. | https://example.com/reference.wav | \ No newline at end of file diff --git a/docs/models/components/speechinputreferenceimage.mdx b/docs/models/components/speechinputreferenceimage.mdx index ed47ce012..a50429cdf 100644 --- a/docs/models/components/speechinputreferenceimage.mdx +++ b/docs/models/components/speechinputreferenceimage.mdx @@ -9,5 +9,5 @@ Reference image describing the desired voice. Cannot be combined with `input_aud | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.SpeechInputReferenceImageInput](../../models/components/speechinputreferenceimageinput.mdx) | ✅ | Reference image input object | -| `Type` | [components.SpeechInputReferenceImageType](../../models/components/speechinputreferenceimagetype.mdx) | ✅ | N/A | \ No newline at end of file +| `ImageURL` | [components.SpeechInputReferenceImageInput](../../models/components/speechinputreferenceimageinput.mdx) | :heavy_check_mark: | Reference image input object | +| `Type` | [components.SpeechInputReferenceImageType](../../models/components/speechinputreferenceimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/speechinputreferenceimageinput.mdx b/docs/models/components/speechinputreferenceimageinput.mdx index e7e550874..5af0f2d24 100644 --- a/docs/models/components/speechinputreferenceimageinput.mdx +++ b/docs/models/components/speechinputreferenceimageinput.mdx @@ -9,4 +9,4 @@ Reference image input object | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `URL` | `string` | ✅ | JPEG, PNG, or WebP reference image as a base64 data URI or a public http(s) URL. Remote images are downloaded (15 MiB max) and forwarded as bytes, never as the URL. | data:image/png;base64,iVBORw0KGgo... | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | JPEG, PNG, or WebP reference image as a base64 data URI or a public http(s) URL. Remote images are downloaded (15 MiB max) and forwarded as bytes, never as the URL. | data:image/png;base64,iVBORw0KGgo... | \ No newline at end of file diff --git a/docs/models/components/speechinputreferencetext.mdx b/docs/models/components/speechinputreferencetext.mdx index f720dff74..c8ab60319 100644 --- a/docs/models/components/speechinputreferencetext.mdx +++ b/docs/models/components/speechinputreferencetext.mdx @@ -9,5 +9,5 @@ Transcript of an `input_audio` part | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Text` | `string` | ✅ | Transcript of an `input_audio` part. With a single clip it may appear before or after the clip; with multiple clips it must immediately follow the clip it transcribes. | I used to rule the world. | -| `Type` | [components.SpeechInputReferenceTextType](../../models/components/speechinputreferencetexttype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Text` | `string` | :heavy_check_mark: | Transcript of an `input_audio` part. With a single clip it may appear before or after the clip; with multiple clips it must immediately follow the clip it transcribes. | I used to rule the world. | +| `Type` | [components.SpeechInputReferenceTextType](../../models/components/speechinputreferencetexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/speechrequest.mdx b/docs/models/components/speechrequest.mdx index 464621247..70bcfd002 100644 --- a/docs/models/components/speechrequest.mdx +++ b/docs/models/components/speechrequest.mdx @@ -9,14 +9,14 @@ Text-to-speech request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Input` | [components.SpeechInput](../../models/components/speechinput.mdx) | ✅ | Text to synthesize, or a list of turns for multi-speaker input. Each turn has its own text, voice, and instructions. Multi-speaker input is currently supported by Gemini TTS models only. | Hello world | -| `InputReferences` | [][components.SpeechInputReference](../../models/components/speechinputreference.mdx) | ➖ | Reference content for stateless voice cloning or voice design. Audio mode: one to three `input_audio` parts, each optionally paired with a `text` part carrying its transcript (a single clip accepts its transcript before or after it; with multiple clips each transcript immediately follows its clip); only routed to endpoints that support voice cloning (and multiple references when more than one part is sent). Image mode: exactly one `image_url` part; only routed to endpoints that support image references. The two modes cannot be mixed. An empty array is treated as no reference. | [
\{
"input_audio": \{
"data": "data:audio/wav;base64,UklGRuQXDABXQVZF..."
},
"type": "input_audio"
},
\{
"text": "I used to rule the world.",
"type": "text"
}
] | -| `Instructions` | `*string` | ➖ | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts and Gemini TTS models. Ignored by other providers. | Speak in a warm and friendly tone. | -| `Model` | `string` | ✅ | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `Provider` | [*components.SpeechRequestProvider](../../models/components/speechrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `ResponseFormat` | [*components.SpeechRequestResponseFormat](../../models/components/speechrequestresponseformat.mdx) | ➖ | Audio output format | pcm | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Speed` | `*float64` | ➖ | Playback speed multiplier. Honored by models that support it (e.g. OpenAI TTS). Other providers either ignore it or return a 400 for a non-default value when the model has no speed control. | 1 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | -| `Voice` | `*string` | ➖ | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file +| `Input` | [components.SpeechInput](../../models/components/speechinput.mdx) | :heavy_check_mark: | Text to synthesize, or a list of turns for multi-speaker input. Each turn has its own text, voice, and instructions. Multi-speaker input is currently supported by Gemini TTS models only. | Hello world | +| `InputReferences` | [][components.SpeechInputReference](../../models/components/speechinputreference.mdx) | :heavy_minus_sign: | Reference content for stateless voice cloning or voice design. Audio mode: one to three `input_audio` parts, each optionally paired with a `text` part carrying its transcript (a single clip accepts its transcript before or after it; with multiple clips each transcript immediately follows its clip); only routed to endpoints that support voice cloning (and multiple references when more than one part is sent). Image mode: exactly one `image_url` part; only routed to endpoints that support image references. The two modes cannot be mixed. An empty array is treated as no reference. | [
\{
"input_audio": \{
"data": "data:audio/wav;base64,UklGRuQXDABXQVZF..."
},
"type": "input_audio"
},
\{
"text": "I used to rule the world.",
"type": "text"
}
] | +| `Instructions` | `*string` | :heavy_minus_sign: | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts and Gemini TTS models. Ignored by other providers. | Speak in a warm and friendly tone. | +| `Model` | `string` | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | +| `Provider` | [*components.SpeechRequestProvider](../../models/components/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `ResponseFormat` | [*components.SpeechRequestResponseFormat](../../models/components/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Speed` | `*float64` | :heavy_minus_sign: | Playback speed multiplier. Honored by models that support it (e.g. OpenAI TTS). Other providers either ignore it or return a 400 for a non-default value when the model has no speed control. | 1 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | +| `Voice` | `*string` | :heavy_minus_sign: | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file diff --git a/docs/models/components/speechrequestprovider.mdx b/docs/models/components/speechrequestprovider.mdx index b7d5321b2..23f0bc0c4 100644 --- a/docs/models/components/speechrequestprovider.mdx +++ b/docs/models/components/speechrequestprovider.mdx @@ -9,6 +9,6 @@ Provider configuration: data policy routing preferences (`zdr`, `data_collection | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DataCollection` | optionalnullable.OptionalNullable[[components.SpeechRequestDataCollection](../../models/components/speechrequestdatacollection.mdx)] | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `Zdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `DataCollection` | optionalnullable.OptionalNullable[[components.SpeechRequestDataCollection](../../models/components/speechrequestdatacollection.mdx)] | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `Zdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/components/speechturn.mdx b/docs/models/components/speechturn.mdx index 80204ed1f..f2ef10bb6 100644 --- a/docs/models/components/speechturn.mdx +++ b/docs/models/components/speechturn.mdx @@ -6,6 +6,6 @@ title: "SpeechTurn" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Instructions` | `*string` | ➖ | Delivery instructions for this turn, such as tone, pacing, or emotion. Overrides the top-level `instructions`. | whispering | -| `Text` | `string` | ✅ | Text to synthesize | Hi Jane. | -| `Voice` | `*string` | ➖ | Voice for this turn. Defaults to the top-level `voice`. | Kore | \ No newline at end of file +| `Instructions` | `*string` | :heavy_minus_sign: | Delivery instructions for this turn, such as tone, pacing, or emotion. Overrides the top-level `instructions`. | whispering | +| `Text` | `string` | :heavy_check_mark: | Text to synthesize | Hi Jane. | +| `Voice` | `*string` | :heavy_minus_sign: | Voice for this turn. Defaults to the top-level `voice`. | Kore | \ No newline at end of file diff --git a/docs/models/components/stance.mdx b/docs/models/components/stance.mdx index 676f0db01..daa1bc601 100644 --- a/docs/models/components/stance.mdx +++ b/docs/models/components/stance.mdx @@ -6,5 +6,5 @@ title: "Stance" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | ✅ | N/A | -| `Stance` | `string` | ✅ | N/A | \ No newline at end of file +| `Model` | `string` | :heavy_check_mark: | N/A | +| `Stance` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenfinishreasonis.mdx b/docs/models/components/stopservertoolswhenfinishreasonis.mdx index 7ad622e15..303e057b0 100644 --- a/docs/models/components/stopservertoolswhenfinishreasonis.mdx +++ b/docs/models/components/stopservertoolswhenfinishreasonis.mdx @@ -9,5 +9,5 @@ Stop when the upstream model emits this finish reason (e.g. `length`). | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Reason` | `string` | ✅ | N/A | -| `Type` | [components.StopServerToolsWhenFinishReasonIsType](../../models/components/stopservertoolswhenfinishreasonistype.mdx) | ✅ | N/A | \ No newline at end of file +| `Reason` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.StopServerToolsWhenFinishReasonIsType](../../models/components/stopservertoolswhenfinishreasonistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenhastoolcall.mdx b/docs/models/components/stopservertoolswhenhastoolcall.mdx index 0c0647002..54c1d4096 100644 --- a/docs/models/components/stopservertoolswhenhastoolcall.mdx +++ b/docs/models/components/stopservertoolswhenhastoolcall.mdx @@ -9,5 +9,5 @@ Stop after a tool with this name has been called. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ToolName` | `string` | ✅ | N/A | -| `Type` | [components.StopServerToolsWhenHasToolCallType](../../models/components/stopservertoolswhenhastoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file +| `ToolName` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.StopServerToolsWhenHasToolCallType](../../models/components/stopservertoolswhenhastoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenmaxcost.mdx b/docs/models/components/stopservertoolswhenmaxcost.mdx index b0d033e24..addcbca5e 100644 --- a/docs/models/components/stopservertoolswhenmaxcost.mdx +++ b/docs/models/components/stopservertoolswhenmaxcost.mdx @@ -9,5 +9,5 @@ Stop once cumulative cost across the loop exceeds this dollar threshold. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `MaxCostInDollars` | `float64` | ✅ | N/A | -| `Type` | [components.StopServerToolsWhenMaxCostType](../../models/components/stopservertoolswhenmaxcosttype.mdx) | ✅ | N/A | \ No newline at end of file +| `MaxCostInDollars` | `float64` | :heavy_check_mark: | N/A | +| `Type` | [components.StopServerToolsWhenMaxCostType](../../models/components/stopservertoolswhenmaxcosttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenmaxtokensused.mdx b/docs/models/components/stopservertoolswhenmaxtokensused.mdx index bdc5b9cfe..c229dcbef 100644 --- a/docs/models/components/stopservertoolswhenmaxtokensused.mdx +++ b/docs/models/components/stopservertoolswhenmaxtokensused.mdx @@ -9,5 +9,5 @@ Stop once cumulative token usage across the loop exceeds this threshold. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `MaxTokens` | `int64` | ✅ | N/A | -| `Type` | [components.StopServerToolsWhenMaxTokensUsedType](../../models/components/stopservertoolswhenmaxtokensusedtype.mdx) | ✅ | N/A | \ No newline at end of file +| `MaxTokens` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.StopServerToolsWhenMaxTokensUsedType](../../models/components/stopservertoolswhenmaxtokensusedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenstepcountis.mdx b/docs/models/components/stopservertoolswhenstepcountis.mdx index d14252fc2..4c7ca7c2b 100644 --- a/docs/models/components/stopservertoolswhenstepcountis.mdx +++ b/docs/models/components/stopservertoolswhenstepcountis.mdx @@ -9,5 +9,5 @@ Stop after the agent loop has executed this many steps. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `StepCount` | `int64` | ✅ | N/A | -| `Type` | [components.StopServerToolsWhenStepCountIsType](../../models/components/stopservertoolswhenstepcountistype.mdx) | ✅ | N/A | \ No newline at end of file +| `StepCount` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.StopServerToolsWhenStepCountIsType](../../models/components/stopservertoolswhenstepcountistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/storedprompttemplate.mdx b/docs/models/components/storedprompttemplate.mdx index f184cc301..9a13ae6cd 100644 --- a/docs/models/components/storedprompttemplate.mdx +++ b/docs/models/components/storedprompttemplate.mdx @@ -6,5 +6,5 @@ title: "StoredPromptTemplate" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | N/A | -| `Variables` | optionalnullable.OptionalNullable[map[string][components.Variables](../../models/components/variables.mdx)] | ➖ | N/A | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Variables` | optionalnullable.OptionalNullable[map[string][components.Variables](../../models/components/variables.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/streameventsresponsecompleted.mdx b/docs/models/components/streameventsresponsecompleted.mdx index 4bf269abc..954b61fb2 100644 --- a/docs/models/components/streameventsresponsecompleted.mdx +++ b/docs/models/components/streameventsresponsecompleted.mdx @@ -9,6 +9,6 @@ Event emitted when a response has completed successfully | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.StreamEventsResponseCompletedType](../../models/components/streameventsresponsecompletedtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.StreamEventsResponseCompletedType](../../models/components/streameventsresponsecompletedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponsefailed.mdx b/docs/models/components/streameventsresponsefailed.mdx index 852bb5e5c..bcc56b0dc 100644 --- a/docs/models/components/streameventsresponsefailed.mdx +++ b/docs/models/components/streameventsresponsefailed.mdx @@ -9,6 +9,6 @@ Event emitted when a response has failed | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.StreamEventsResponseFailedType](../../models/components/streameventsresponsefailedtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.StreamEventsResponseFailedType](../../models/components/streameventsresponsefailedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseincomplete.mdx b/docs/models/components/streameventsresponseincomplete.mdx index e6c3b3901..5f90aadd1 100644 --- a/docs/models/components/streameventsresponseincomplete.mdx +++ b/docs/models/components/streameventsresponseincomplete.mdx @@ -9,6 +9,6 @@ Event emitted when a response is incomplete | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.StreamEventsResponseIncompleteType](../../models/components/streameventsresponseincompletetype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.StreamEventsResponseIncompleteType](../../models/components/streameventsresponseincompletetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseoutputitemadded.mdx b/docs/models/components/streameventsresponseoutputitemadded.mdx index 6357d74a5..17f170a7e 100644 --- a/docs/models/components/streameventsresponseoutputitemadded.mdx +++ b/docs/models/components/streameventsresponseoutputitemadded.mdx @@ -9,7 +9,7 @@ Event emitted when a new output item is added to the response | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | ✅ | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | -| `OutputIndex` | `int64` | ✅ | N/A | | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.StreamEventsResponseOutputItemAddedType](../../models/components/streameventsresponseoutputitemaddedtype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | :heavy_check_mark: | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.StreamEventsResponseOutputItemAddedType](../../models/components/streameventsresponseoutputitemaddedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseoutputitemdone.mdx b/docs/models/components/streameventsresponseoutputitemdone.mdx index 6d1600574..78dd4200f 100644 --- a/docs/models/components/streameventsresponseoutputitemdone.mdx +++ b/docs/models/components/streameventsresponseoutputitemdone.mdx @@ -9,7 +9,7 @@ Event emitted when an output item is complete | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | ✅ | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | -| `OutputIndex` | `int64` | ✅ | N/A | | -| `SequenceNumber` | `int64` | ✅ | N/A | | -| `Type` | [components.StreamEventsResponseOutputItemDoneType](../../models/components/streameventsresponseoutputitemdonetype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | :heavy_check_mark: | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | +| `Type` | [components.StreamEventsResponseOutputItemDoneType](../../models/components/streameventsresponseoutputitemdonetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streamlogprob.mdx b/docs/models/components/streamlogprob.mdx index 1a8ee5a6b..4868841c9 100644 --- a/docs/models/components/streamlogprob.mdx +++ b/docs/models/components/streamlogprob.mdx @@ -9,7 +9,7 @@ Log probability information for a token | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | ➖ | N/A | -| `Logprob` | `float64` | ✅ | N/A | -| `Token` | `string` | ✅ | N/A | -| `TopLogprobs` | [][components.StreamLogprobTopLogprob](../../models/components/streamlogprobtoplogprob.mdx) | ➖ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_minus_sign: | N/A | +| `Logprob` | `float64` | :heavy_check_mark: | N/A | +| `Token` | `string` | :heavy_check_mark: | N/A | +| `TopLogprobs` | [][components.StreamLogprobTopLogprob](../../models/components/streamlogprobtoplogprob.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/streamlogprobtoplogprob.mdx b/docs/models/components/streamlogprobtoplogprob.mdx index 99943e74c..d0098a430 100644 --- a/docs/models/components/streamlogprobtoplogprob.mdx +++ b/docs/models/components/streamlogprobtoplogprob.mdx @@ -9,6 +9,6 @@ Alternative token with its log probability | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | ➖ | N/A | -| `Logprob` | `*float64` | ➖ | N/A | -| `Token` | `*string` | ➖ | N/A | \ No newline at end of file +| `Bytes` | []`int64` | :heavy_minus_sign: | N/A | +| `Logprob` | `*float64` | :heavy_minus_sign: | N/A | +| `Token` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/stt.mdx b/docs/models/components/stt.mdx index a96a0a8b6..19d7f7524 100644 --- a/docs/models/components/stt.mdx +++ b/docs/models/components/stt.mdx @@ -6,6 +6,6 @@ title: "STT" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/sttentity.mdx b/docs/models/components/sttentity.mdx index 206962551..3b5fa9e3a 100644 --- a/docs/models/components/sttentity.mdx +++ b/docs/models/components/sttentity.mdx @@ -9,7 +9,7 @@ A detected entity, returned when the provider runs entity detection | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `EndChar` | `int64` | ✅ | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | -| `StartChar` | `int64` | ✅ | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | -| `Text` | `string` | ✅ | Entity text as it appears in the transcript | | -| `Type` | `string` | ✅ | Provider entity type label | name | \ No newline at end of file +| `EndChar` | `int64` | :heavy_check_mark: | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | +| `StartChar` | `int64` | :heavy_check_mark: | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | +| `Text` | `string` | :heavy_check_mark: | Entity text as it appears in the transcript | | +| `Type` | `string` | :heavy_check_mark: | Provider entity type label | name | \ No newline at end of file diff --git a/docs/models/components/sttinlineinputaudio.mdx b/docs/models/components/sttinlineinputaudio.mdx index f48fe33d9..900fddb90 100644 --- a/docs/models/components/sttinlineinputaudio.mdx +++ b/docs/models/components/sttinlineinputaudio.mdx @@ -9,5 +9,5 @@ Inline base64 audio input for speech-to-text | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | ✅ | Base64-encoded audio data (raw bytes, not a data URI) | -| `Format` | `string` | ✅ | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. "pcm" means headerless signed 16-bit little-endian mono audio at 16 kHz. | \ No newline at end of file +| `Data` | `string` | :heavy_check_mark: | Base64-encoded audio data (raw bytes, not a data URI) | +| `Format` | `string` | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. "pcm" means headerless signed 16-bit little-endian mono audio at 16 kHz. | \ No newline at end of file diff --git a/docs/models/components/sttrequest.mdx b/docs/models/components/sttrequest.mdx index 27c49313f..3989cdd98 100644 --- a/docs/models/components/sttrequest.mdx +++ b/docs/models/components/sttrequest.mdx @@ -9,15 +9,15 @@ Speech-to-text request input. Accepts a JSON body with input_audio containing ba | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Diarize` | `*bool` | ➖ | Label each word with the speaker who said it. Speaker labels are returned on the words array (speaker, speaker_label), so response_format must be "verbose_json" (a "json" request is rejected with a 400) and word timestamps are included even when timestamp_granularities omits "word". Only supported by some providers; the request is rejected with a 400 when the selected model cannot diarize. Providers may charge extra. | true | -| `InputAudio` | [components.STTInputAudio](../../models/components/sttinputaudio.mdx) | ✅ | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | -| `Keyterms` | []`string` | ➖ | Domain terms, names, or phrases to bias recognition toward. Only supported by some providers; the request is rejected with a 400 when the selected model cannot use keyterms. Providers may cap the number of terms or characters per term and may charge extra. | [
"OpenRouter",
"Scribe"
] | -| `Language` | `*string` | ➖ | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `Model` | `string` | ✅ | STT model identifier | openai/whisper-large-v3 | -| `Provider` | [*components.STTRequestProvider](../../models/components/sttrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `ResponseFormat` | [*components.STTRequestResponseFormat](../../models/components/sttrequestresponseformat.mdx) | ➖ | Output format. "json" (default) returns \{ text, usage }. "verbose_json" additionally returns task, language, duration, and segment-level timestamps; only supported by OpenAI-compatible providers. | json | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Temperature` | `*float64` | ➖ | Sampling temperature for transcription | 0 | -| `TimestampGranularities` | [][components.STTTimestampGranularity](../../models/components/stttimestampgranularity.mdx) | ➖ | Timestamp detail levels to include when response_format is "verbose_json". "segment" returns segment-level timestamps; "word" additionally returns word-level timestamps in the words array. Ignored unless response_format is "verbose_json". | [
"segment"
] | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `Diarize` | `*bool` | :heavy_minus_sign: | Label each word with the speaker who said it. Speaker labels are returned on the words array (speaker, speaker_label), so response_format must be "verbose_json" (a "json" request is rejected with a 400) and word timestamps are included even when timestamp_granularities omits "word". Only supported by some providers; the request is rejected with a 400 when the selected model cannot diarize. Providers may charge extra. | true | +| `InputAudio` | [components.STTInputAudio](../../models/components/sttinputaudio.mdx) | :heavy_check_mark: | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | +| `Keyterms` | []`string` | :heavy_minus_sign: | Domain terms, names, or phrases to bias recognition toward. Only supported by some providers; the request is rejected with a 400 when the selected model cannot use keyterms. Providers may cap the number of terms or characters per term and may charge extra. | [
"OpenRouter",
"Scribe"
] | +| `Language` | `*string` | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | +| `Model` | `string` | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | +| `Provider` | [*components.STTRequestProvider](../../models/components/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `ResponseFormat` | [*components.STTRequestResponseFormat](../../models/components/sttrequestresponseformat.mdx) | :heavy_minus_sign: | Output format. "json" (default) returns \{ text, usage }. "verbose_json" additionally returns task, language, duration, and segment-level timestamps; only supported by OpenAI-compatible providers. | json | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature for transcription | 0 | +| `TimestampGranularities` | [][components.STTTimestampGranularity](../../models/components/stttimestampgranularity.mdx) | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "segment" returns segment-level timestamps; "word" additionally returns word-level timestamps in the words array. Ignored unless response_format is "verbose_json". | [
"segment"
] | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/components/sttrequestprovider.mdx b/docs/models/components/sttrequestprovider.mdx index ae51b3d99..6d5dd6175 100644 --- a/docs/models/components/sttrequestprovider.mdx +++ b/docs/models/components/sttrequestprovider.mdx @@ -9,6 +9,6 @@ Provider configuration: data policy routing preferences (`zdr`, `data_collection | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DataCollection` | optionalnullable.OptionalNullable[[components.STTRequestDataCollection](../../models/components/sttrequestdatacollection.mdx)] | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `Zdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `DataCollection` | optionalnullable.OptionalNullable[[components.STTRequestDataCollection](../../models/components/sttrequestdatacollection.mdx)] | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `Zdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/components/sttresponse.mdx b/docs/models/components/sttresponse.mdx index 84268e251..c91201a9d 100644 --- a/docs/models/components/sttresponse.mdx +++ b/docs/models/components/sttresponse.mdx @@ -9,13 +9,13 @@ STT response containing transcribed text and optional usage statistics | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Confidence` | `*float64` | ➖ | Provider confidence for the whole transcript from 0 to 1, present when response_format is verbose_json and the provider scores the full transcript | 0.94 | -| `Duration` | `*float64` | ➖ | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | -| `Entities` | [][components.STTEntity](../../models/components/sttentity.mdx) | ➖ | Detected entities with character offsets into text, present when the provider runs entity detection | | -| `Language` | `*string` | ➖ | Detected or forced language, present when response_format is verbose_json | english | -| `LanguageConfidence` | `*float64` | ➖ | Provider confidence in the detected language from 0 to 1, present when response_format is verbose_json and the provider scores language detection | 0.98 | -| `Segments` | [][components.STTSegment](../../models/components/sttsegment.mdx) | ➖ | Timestamped transcript segments, present when response_format is verbose_json | | -| `Task` | `*string` | ➖ | The task performed, present when response_format is verbose_json | transcribe | -| `Text` | `string` | ✅ | The transcribed text | Hello, this is a test of OpenAI speech-to-text transcription. The weather is sunny today and the temperature is around 72 degrees. | -| `Usage` | [*components.STTUsage](../../models/components/sttusage.mdx) | ➖ | Aggregated usage statistics for the request | \{
"cost": 0.000508,
"input_tokens": 83,
"output_tokens": 30,
"seconds": 9.2,
"total_tokens": 113
} | -| `Words` | [][components.STTWord](../../models/components/sttword.mdx) | ➖ | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file +| `Confidence` | `*float64` | :heavy_minus_sign: | Provider confidence for the whole transcript from 0 to 1, present when response_format is verbose_json and the provider scores the full transcript | 0.94 | +| `Duration` | `*float64` | :heavy_minus_sign: | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | +| `Entities` | [][components.STTEntity](../../models/components/sttentity.mdx) | :heavy_minus_sign: | Detected entities with character offsets into text, present when the provider runs entity detection | | +| `Language` | `*string` | :heavy_minus_sign: | Detected or forced language, present when response_format is verbose_json | english | +| `LanguageConfidence` | `*float64` | :heavy_minus_sign: | Provider confidence in the detected language from 0 to 1, present when response_format is verbose_json and the provider scores language detection | 0.98 | +| `Segments` | [][components.STTSegment](../../models/components/sttsegment.mdx) | :heavy_minus_sign: | Timestamped transcript segments, present when response_format is verbose_json | | +| `Task` | `*string` | :heavy_minus_sign: | The task performed, present when response_format is verbose_json | transcribe | +| `Text` | `string` | :heavy_check_mark: | The transcribed text | Hello, this is a test of OpenAI speech-to-text transcription. The weather is sunny today and the temperature is around 72 degrees. | +| `Usage` | [*components.STTUsage](../../models/components/sttusage.mdx) | :heavy_minus_sign: | Aggregated usage statistics for the request | \{
"cost": 0.000508,
"input_tokens": 83,
"output_tokens": 30,
"seconds": 9.2,
"total_tokens": 113
} | +| `Words` | [][components.STTWord](../../models/components/sttword.mdx) | :heavy_minus_sign: | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file diff --git a/docs/models/components/sttsegment.mdx b/docs/models/components/sttsegment.mdx index e307f7034..5f3748e3d 100644 --- a/docs/models/components/sttsegment.mdx +++ b/docs/models/components/sttsegment.mdx @@ -9,16 +9,16 @@ A timestamped transcript segment, returned when response_format is verbose_json | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `AvgLogprob` | `*float64` | ➖ | Average log probability of the segment | | -| `Channel` | `*int64` | ➖ | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | -| `CompressionRatio` | `*float64` | ➖ | Compression ratio of the segment | | -| `End` | `float64` | ✅ | Segment end time in seconds | 3.2 | -| `ID` | `int64` | ✅ | Segment index within the transcript | 0 | -| `NoSpeechProb` | `*float64` | ➖ | Probability the segment contains no speech | | -| `Seek` | `*int64` | ➖ | Seek offset of the segment | 0 | -| `Speaker` | `*int64` | ➖ | Speaker index for the segment, present when the provider returns diarization data | 0 | -| `SpeakerLabel` | `*string` | ➖ | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | -| `Start` | `float64` | ✅ | Segment start time in seconds | 0 | -| `Temperature` | `*float64` | ➖ | Temperature used for the segment | | -| `Text` | `string` | ✅ | Transcribed text of the segment | Hello there. | -| `Tokens` | []`int64` | ➖ | Token IDs of the segment | | \ No newline at end of file +| `AvgLogprob` | `*float64` | :heavy_minus_sign: | Average log probability of the segment | | +| `Channel` | `*int64` | :heavy_minus_sign: | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | +| `CompressionRatio` | `*float64` | :heavy_minus_sign: | Compression ratio of the segment | | +| `End` | `float64` | :heavy_check_mark: | Segment end time in seconds | 3.2 | +| `ID` | `int64` | :heavy_check_mark: | Segment index within the transcript | 0 | +| `NoSpeechProb` | `*float64` | :heavy_minus_sign: | Probability the segment contains no speech | | +| `Seek` | `*int64` | :heavy_minus_sign: | Seek offset of the segment | 0 | +| `Speaker` | `*int64` | :heavy_minus_sign: | Speaker index for the segment, present when the provider returns diarization data | 0 | +| `SpeakerLabel` | `*string` | :heavy_minus_sign: | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | +| `Start` | `float64` | :heavy_check_mark: | Segment start time in seconds | 0 | +| `Temperature` | `*float64` | :heavy_minus_sign: | Temperature used for the segment | | +| `Text` | `string` | :heavy_check_mark: | Transcribed text of the segment | Hello there. | +| `Tokens` | []`int64` | :heavy_minus_sign: | Token IDs of the segment | | \ No newline at end of file diff --git a/docs/models/components/stturlinputaudio.mdx b/docs/models/components/stturlinputaudio.mdx index c5069ec63..97d6c70d6 100644 --- a/docs/models/components/stturlinputaudio.mdx +++ b/docs/models/components/stturlinputaudio.mdx @@ -9,5 +9,5 @@ Audio input fetched by the provider from a URL | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Format` | `*string` | ➖ | Audio format of the file at the URL. Defaults to the extension of the URL path; required when the path has no extension. | -| `URL` | `string` | ✅ | Publicly reachable http(s) URL of the audio file. The provider downloads it directly, so the inline upload size limit does not apply. Only supported by some providers. | \ No newline at end of file +| `Format` | `*string` | :heavy_minus_sign: | Audio format of the file at the URL. Defaults to the extension of the URL path; required when the path has no extension. | +| `URL` | `string` | :heavy_check_mark: | Publicly reachable http(s) URL of the audio file. The provider downloads it directly, so the inline upload size limit does not apply. Only supported by some providers. | \ No newline at end of file diff --git a/docs/models/components/sttusage.mdx b/docs/models/components/sttusage.mdx index 5aa829a2d..23197551f 100644 --- a/docs/models/components/sttusage.mdx +++ b/docs/models/components/sttusage.mdx @@ -9,8 +9,8 @@ Aggregated usage statistics for the request | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `Cost` | `*float64` | ➖ | Total cost of the request in USD | 0.000508 | -| `InputTokens` | `*int64` | ➖ | Number of input tokens billed for this request | 83 | -| `OutputTokens` | `*int64` | ➖ | Number of output tokens generated | 30 | -| `Seconds` | `*float64` | ➖ | Duration of the input audio in seconds | 9.2 | -| `TotalTokens` | `*int64` | ➖ | Total number of tokens used (input + output) | 113 | \ No newline at end of file +| `Cost` | `*float64` | :heavy_minus_sign: | Total cost of the request in USD | 0.000508 | +| `InputTokens` | `*int64` | :heavy_minus_sign: | Number of input tokens billed for this request | 83 | +| `OutputTokens` | `*int64` | :heavy_minus_sign: | Number of output tokens generated | 30 | +| `Seconds` | `*float64` | :heavy_minus_sign: | Duration of the input audio in seconds | 9.2 | +| `TotalTokens` | `*int64` | :heavy_minus_sign: | Total number of tokens used (input + output) | 113 | \ No newline at end of file diff --git a/docs/models/components/sttword.mdx b/docs/models/components/sttword.mdx index 8603951d2..e482d6427 100644 --- a/docs/models/components/sttword.mdx +++ b/docs/models/components/sttword.mdx @@ -9,11 +9,11 @@ A timestamped word, returned when the provider includes word-level timestamps | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Channel` | `*int64` | ➖ | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | -| `Confidence` | `*float64` | ➖ | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | -| `End` | `float64` | ✅ | Word end time in seconds | 0.4 | -| `Speaker` | `*int64` | ➖ | Speaker index for the word, present when the provider returns diarization data | 0 | -| `SpeakerLabel` | `*string` | ➖ | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | -| `Start` | `float64` | ✅ | Word start time in seconds | 0 | -| `Type` | [*components.STTWordType](../../models/components/sttwordtype.mdx) | ➖ | Kind of entry; omitted or "word" for spoken words, "audio_event" for non-speech sounds the provider tags with timestamps | word | -| `Word` | `string` | ✅ | The transcribed word, or the event tag such as "(laughter)" when type is audio_event | Hello | \ No newline at end of file +| `Channel` | `*int64` | :heavy_minus_sign: | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | +| `Confidence` | `*float64` | :heavy_minus_sign: | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | +| `End` | `float64` | :heavy_check_mark: | Word end time in seconds | 0.4 | +| `Speaker` | `*int64` | :heavy_minus_sign: | Speaker index for the word, present when the provider returns diarization data | 0 | +| `SpeakerLabel` | `*string` | :heavy_minus_sign: | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | +| `Start` | `float64` | :heavy_check_mark: | Word start time in seconds | 0 | +| `Type` | [*components.STTWordType](../../models/components/sttwordtype.mdx) | :heavy_minus_sign: | Kind of entry; omitted or "word" for spoken words, "audio_event" for non-speech sounds the provider tags with timestamps | word | +| `Word` | `string` | :heavy_check_mark: | The transcribed word, or the event tag such as "(laughter)" when type is audio_event | Hello | \ No newline at end of file diff --git a/docs/models/components/subagentnestedtool.mdx b/docs/models/components/subagentnestedtool.mdx index a7c849a56..e11bb182c 100644 --- a/docs/models/components/subagentnestedtool.mdx +++ b/docs/models/components/subagentnestedtool.mdx @@ -9,6 +9,6 @@ A tool made available to the subagent. Only OpenRouter server tools (e.g. openro | Field | Type | Required | Description | Example | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `Parameters` | map[string]`any` | ➖ | N/A | | -| `Type` | `string` | ✅ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file +| `Parameters` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `Type` | `string` | :heavy_check_mark: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file diff --git a/docs/models/components/subagentreasoning.mdx b/docs/models/components/subagentreasoning.mdx index 4fc27b0f8..a05864f16 100644 --- a/docs/models/components/subagentreasoning.mdx +++ b/docs/models/components/subagentreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the subagent call. Use this to control reas | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Effort` | [*components.SubagentReasoningEffort](../../models/components/subagentreasoningeffort.mdx) | ➖ | Reasoning effort level for the subagent call. | -| `MaxTokens` | `*int64` | ➖ | Maximum number of reasoning tokens the subagent may use. Forwarded to the subagent call as `reasoning.max_tokens`. | \ No newline at end of file +| `Effort` | [*components.SubagentReasoningEffort](../../models/components/subagentreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | +| `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens the subagent may use. Forwarded to the subagent call as `reasoning.max_tokens`. | \ No newline at end of file diff --git a/docs/models/components/subagentservertoolconfig.mdx b/docs/models/components/subagentservertoolconfig.mdx index 448b17f34..0f245741f 100644 --- a/docs/models/components/subagentservertoolconfig.mdx +++ b/docs/models/components/subagentservertoolconfig.mdx @@ -9,13 +9,13 @@ Configuration for one openrouter:subagent server tool entry. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `InheritFunctions` | `*bool` | ➖ | EXPERIMENTAL — subject to change without notice. When true, the subagent inherits every client function defined in the request's top-level `tools` list. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | true | -| `InheritedFunctionNames` | []`string` | ➖ | EXPERIMENTAL — subject to change without notice. Names of the top-level function tools that the subagent will inherit. Any tool that matches by name will be copied fully into the tools array of the subagent. When `inherit_functions` is `true`, this list does nothing, because every client function will be inherited by default. Names are trimmed before validation, so a whitespace-only name is rejected with a `400`. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | [
"lookup_order"
] | -| `Instructions` | `*string` | ➖ | System instructions for the subagent. When omitted, the subagent responds with no system prompt of its own. | You are a fast, focused worker. Complete the task exactly as described. | -| `MaxCompletionTokens` | `*int64` | ➖ | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | -| `MaxToolCalls` | `*int64` | ➖ | Maximum number of tool-calling steps the subagent may take during its agentic loop. Capped at 25. Only relevant when the subagent is given tools. Forwarded to the subagent call as `max_tool_calls`. | 5 | -| `Model` | `*string` | ➖ | Slug of the model that executes delegated tasks (any OpenRouter model). Typically a smaller, cheaper, faster model than the one delegating. When omitted, the model from the outer API request is used. The subagent tool itself cannot be the subagent model. | ~anthropic/claude-haiku-latest | -| `Name` | `*string` | ➖ | Optional name for this subagent. The model sees one tool per named subagent (and one default for an unnamed entry). Names must be unique across subagent entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | summarizer | -| `Reasoning` | [*components.SubagentReasoning](../../models/components/subagentreasoning.mdx) | ➖ | Reasoning configuration forwarded to the subagent call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "low"
} | -| `Temperature` | `*float64` | ➖ | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | -| `Tools` | [][components.SubagentNestedTool](../../models/components/subagentnestedtool.mdx) | ➖ | Tools the subagent may use while executing a delegated task. The subagent runs as an agentic sub-agent over these tools, then returns its outcome. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the subagent tool itself. | | \ No newline at end of file +| `InheritFunctions` | `*bool` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. When true, the subagent inherits every client function defined in the request's top-level `tools` list. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | true | +| `InheritedFunctionNames` | []`string` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. Names of the top-level function tools that the subagent will inherit. Any tool that matches by name will be copied fully into the tools array of the subagent. When `inherit_functions` is `true`, this list does nothing, because every client function will be inherited by default. Names are trimmed before validation, so a whitespace-only name is rejected with a `400`. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | [
"lookup_order"
] | +| `Instructions` | `*string` | :heavy_minus_sign: | System instructions for the subagent. When omitted, the subagent responds with no system prompt of its own. | You are a fast, focused worker. Complete the task exactly as described. | +| `MaxCompletionTokens` | `*int64` | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | +| `MaxToolCalls` | `*int64` | :heavy_minus_sign: | Maximum number of tool-calling steps the subagent may take during its agentic loop. Capped at 25. Only relevant when the subagent is given tools. Forwarded to the subagent call as `max_tool_calls`. | 5 | +| `Model` | `*string` | :heavy_minus_sign: | Slug of the model that executes delegated tasks (any OpenRouter model). Typically a smaller, cheaper, faster model than the one delegating. When omitted, the model from the outer API request is used. The subagent tool itself cannot be the subagent model. | ~anthropic/claude-haiku-latest | +| `Name` | `*string` | :heavy_minus_sign: | Optional name for this subagent. The model sees one tool per named subagent (and one default for an unnamed entry). Names must be unique across subagent entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | summarizer | +| `Reasoning` | [*components.SubagentReasoning](../../models/components/subagentreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to the subagent call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "low"
} | +| `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | +| `Tools` | [][components.SubagentNestedTool](../../models/components/subagentnestedtool.mdx) | :heavy_minus_sign: | Tools the subagent may use while executing a delegated task. The subagent runs as an agentic sub-agent over these tools, then returns its outcome. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the subagent tool itself. | | \ No newline at end of file diff --git a/docs/models/components/subagentservertoolopenrouter.mdx b/docs/models/components/subagentservertoolopenrouter.mdx index 63fa3a71f..b14fa52d4 100644 --- a/docs/models/components/subagentservertoolopenrouter.mdx +++ b/docs/models/components/subagentservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: delegates self-contained tasks to a smaller, ch | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.SubagentServerToolConfig](../../models/components/subagentservertoolconfig.mdx) | ➖ | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | -| `Type` | [components.SubagentServerToolOpenRouterType](../../models/components/subagentservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.SubagentServerToolConfig](../../models/components/subagentservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | +| `Type` | [components.SubagentServerToolOpenRouterType](../../models/components/subagentservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/submitgenerationfeedbackrequest.mdx b/docs/models/components/submitgenerationfeedbackrequest.mdx index 1487690fe..2f85badb8 100644 --- a/docs/models/components/submitgenerationfeedbackrequest.mdx +++ b/docs/models/components/submitgenerationfeedbackrequest.mdx @@ -9,6 +9,6 @@ Structured feedback about a specific generation | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Category` | [components.SubmitGenerationFeedbackRequestCategory](../../models/components/submitgenerationfeedbackrequestcategory.mdx) | ✅ | The category of feedback being reported | incorrect_response | -| `Comment` | `*string` | ➖ | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | -| `GenerationID` | `string` | ✅ | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file +| `Category` | [components.SubmitGenerationFeedbackRequestCategory](../../models/components/submitgenerationfeedbackrequestcategory.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | +| `Comment` | `*string` | :heavy_minus_sign: | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | +| `GenerationID` | `string` | :heavy_check_mark: | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file diff --git a/docs/models/components/submitgenerationfeedbackresponse.mdx b/docs/models/components/submitgenerationfeedbackresponse.mdx index 5dcfa30ff..c4c9de38c 100644 --- a/docs/models/components/submitgenerationfeedbackresponse.mdx +++ b/docs/models/components/submitgenerationfeedbackresponse.mdx @@ -9,4 +9,4 @@ Confirmation that the feedback was recorded | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.SubmitGenerationFeedbackResponseData](../../models/components/submitgenerationfeedbackresponsedata.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.SubmitGenerationFeedbackResponseData](../../models/components/submitgenerationfeedbackresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/submitgenerationfeedbackresponsedata.mdx b/docs/models/components/submitgenerationfeedbackresponsedata.mdx index 8cca376ac..8b77b76c5 100644 --- a/docs/models/components/submitgenerationfeedbackresponsedata.mdx +++ b/docs/models/components/submitgenerationfeedbackresponsedata.mdx @@ -6,4 +6,4 @@ title: "SubmitGenerationFeedbackResponseData" | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `Success` | `bool` | ✅ | Whether the feedback was recorded | true | \ No newline at end of file +| `Success` | `bool` | :heavy_check_mark: | Whether the feedback was recorded | true | \ No newline at end of file diff --git a/docs/models/components/suspendinternresponse.mdx b/docs/models/components/suspendinternresponse.mdx index c7e5fd966..5f1fdbb8f 100644 --- a/docs/models/components/suspendinternresponse.mdx +++ b/docs/models/components/suspendinternresponse.mdx @@ -6,4 +6,4 @@ title: "SuspendInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Suspended` | `bool` | ✅ | N/A | \ No newline at end of file +| `Suspended` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/switchyardrouterplugin.mdx b/docs/models/components/switchyardrouterplugin.mdx index 5755a0eed..c4b4857f2 100644 --- a/docs/models/components/switchyardrouterplugin.mdx +++ b/docs/models/components/switchyardrouterplugin.mdx @@ -6,6 +6,6 @@ title: "SwitchyardRouterPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Algorithm` | [*components.Algorithm](../../models/components/algorithm.mdx) | ➖ | Routing algorithm for this request. "capability" calls a small judge model to rate how demanding the task is, then picks the efficient or capable candidate. "stage" reads the tool-result history (errors, repeated failures, edits landing) and calls the judge only when those signals are undecided. "auto" is "stage" without the judge call. "random" picks one candidate at random. "composite" keeps the tier chosen on the last human turn and re-evaluates tool turns with the stage signals. "passthrough" serves the eligible candidates in the order OpenRouter already ranked them, with no routing decision and no judge call. Omit this field to use the platform default, stage. | | -| `ID` | [components.SwitchyardRouterPluginID](../../models/components/switchyardrouterpluginid.mdx) | ✅ | N/A | | -| `JudgeModel` | `*string` | ➖ | The model that runs the judge call for the judge-backed algorithms ("capability", "stage", and "composite"). The model must support structured outputs and have a provider that your account and request settings allow. Otherwise, the request uses the platform default judge, google/gemini-3.5-flash-lite, or openai/gpt-4o-mini when the default does not fit either, and reports the reason in the routing metadata. The judge call is billed to you like any other request. | openai/gpt-5.4-nano | \ No newline at end of file +| `Algorithm` | [*components.Algorithm](../../models/components/algorithm.mdx) | :heavy_minus_sign: | Routing algorithm for this request. "capability" calls a small judge model to rate how demanding the task is, then picks the efficient or capable candidate. "stage" reads the tool-result history (errors, repeated failures, edits landing) and calls the judge only when those signals are undecided. "auto" is "stage" without the judge call. "random" picks one candidate at random. "composite" keeps the tier chosen on the last human turn and re-evaluates tool turns with the stage signals. "passthrough" serves the eligible candidates in the order OpenRouter already ranked them, with no routing decision and no judge call. Omit this field to use the platform default, stage. | | +| `ID` | [components.SwitchyardRouterPluginID](../../models/components/switchyardrouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `JudgeModel` | `*string` | :heavy_minus_sign: | The model that runs the judge call for the judge-backed algorithms ("capability", "stage", and "composite"). The model must support structured outputs and have a provider that your account and request settings allow. Otherwise, the request uses the platform default judge, google/gemini-3.5-flash-lite, or openai/gpt-4o-mini when the default does not fit either, and reports the reason in the routing metadata. The judge call is billed to you like any other request. | openai/gpt-5.4-nano | \ No newline at end of file diff --git a/docs/models/components/taskbudget.mdx b/docs/models/components/taskbudget.mdx index 94cb1d952..c59ed5701 100644 --- a/docs/models/components/taskbudget.mdx +++ b/docs/models/components/taskbudget.mdx @@ -9,6 +9,6 @@ Task budget for an agentic turn. The model sees a countdown of remaining tokens | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Remaining` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | -| `Total` | `int64` | ✅ | N/A | -| `Type` | [components.TypeTokens](../../models/components/typetokens.mdx) | ✅ | N/A | \ No newline at end of file +| `Remaining` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | +| `Total` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.TypeTokens](../../models/components/typetokens.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/taskclassificationitem.mdx b/docs/models/components/taskclassificationitem.mdx index e90fc3ba0..a045e9e59 100644 --- a/docs/models/components/taskclassificationitem.mdx +++ b/docs/models/components/taskclassificationitem.mdx @@ -6,11 +6,11 @@ title: "TaskClassificationItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CategoryTokenShare` | `float64` | ✅ | Fraction of this classification's token volume within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.48 | -| `CategoryUsageShare` | `float64` | ✅ | Fraction of this classification's usage within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.51 | -| `DisplayName` | `string` | ✅ | Human-readable label for the classification. | Code Generation | -| `MacroCategory` | `string` | ✅ | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | -| `Models` | [][components.TaskClassificationModel](../../models/components/taskclassificationmodel.mdx) | ✅ | Top models for this classification by request volume, sorted descending. Each entry reports the model's share of this classification's requests and tokens. | | -| `Tag` | `string` | ✅ | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | -| `TokenShare` | `float64` | ✅ | Fraction of classified sampled token volume (prompt + completion) attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.31 | -| `UsageShare` | `float64` | ✅ | Fraction of classified sampled requests attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.23 | \ No newline at end of file +| `CategoryTokenShare` | `float64` | :heavy_check_mark: | Fraction of this classification's token volume within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.48 | +| `CategoryUsageShare` | `float64` | :heavy_check_mark: | Fraction of this classification's usage within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.51 | +| `DisplayName` | `string` | :heavy_check_mark: | Human-readable label for the classification. | Code Generation | +| `MacroCategory` | `string` | :heavy_check_mark: | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | +| `Models` | [][components.TaskClassificationModel](../../models/components/taskclassificationmodel.mdx) | :heavy_check_mark: | Top models for this classification by request volume, sorted descending. Each entry reports the model's share of this classification's requests and tokens. | | +| `Tag` | `string` | :heavy_check_mark: | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | +| `TokenShare` | `float64` | :heavy_check_mark: | Fraction of classified sampled token volume (prompt + completion) attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.31 | +| `UsageShare` | `float64` | :heavy_check_mark: | Fraction of classified sampled requests attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.23 | \ No newline at end of file diff --git a/docs/models/components/taskclassificationmacrocategory.mdx b/docs/models/components/taskclassificationmacrocategory.mdx index 893afac08..82dc99918 100644 --- a/docs/models/components/taskclassificationmacrocategory.mdx +++ b/docs/models/components/taskclassificationmacrocategory.mdx @@ -6,7 +6,7 @@ title: "TaskClassificationMacroCategory" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Key` | `string` | ✅ | Macro-category identifier. | code | -| `Label` | `string` | ✅ | Human-readable label for the macro-category. | Code | -| `TokenShare` | `float64` | ✅ | Combined token share of all classifications in this macro-category (0–1). | 0.52 | -| `UsageShare` | `float64` | ✅ | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file +| `Key` | `string` | :heavy_check_mark: | Macro-category identifier. | code | +| `Label` | `string` | :heavy_check_mark: | Human-readable label for the macro-category. | Code | +| `TokenShare` | `float64` | :heavy_check_mark: | Combined token share of all classifications in this macro-category (0–1). | 0.52 | +| `UsageShare` | `float64` | :heavy_check_mark: | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file diff --git a/docs/models/components/taskclassificationmodel.mdx b/docs/models/components/taskclassificationmodel.mdx index edb6e0690..0ae63dab3 100644 --- a/docs/models/components/taskclassificationmodel.mdx +++ b/docs/models/components/taskclassificationmodel.mdx @@ -6,6 +6,6 @@ title: "TaskClassificationModel" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | Model identifier (permaslug). | openai/gpt-4.1-mini | -| `TagTokenShare` | `float64` | ✅ | Fraction of this classification's sampled token volume attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.75 | -| `TagUsageShare` | `float64` | ✅ | Fraction of this classification's sampled requests attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.55 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Model identifier (permaslug). | openai/gpt-4.1-mini | +| `TagTokenShare` | `float64` | :heavy_check_mark: | Fraction of this classification's sampled token volume attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.75 | +| `TagUsageShare` | `float64` | :heavy_check_mark: | Fraction of this classification's sampled requests attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.55 | \ No newline at end of file diff --git a/docs/models/components/taskclassificationresponse.mdx b/docs/models/components/taskclassificationresponse.mdx index 165cd4a38..2e98b3220 100644 --- a/docs/models/components/taskclassificationresponse.mdx +++ b/docs/models/components/taskclassificationresponse.mdx @@ -6,4 +6,4 @@ title: "TaskClassificationResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Data` | [components.TaskClassificationResponseData](../../models/components/taskclassificationresponsedata.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.TaskClassificationResponseData](../../models/components/taskclassificationresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/taskclassificationresponsedata.mdx b/docs/models/components/taskclassificationresponsedata.mdx index ef7557b6f..829d78b70 100644 --- a/docs/models/components/taskclassificationresponsedata.mdx +++ b/docs/models/components/taskclassificationresponsedata.mdx @@ -6,7 +6,7 @@ title: "TaskClassificationResponseData" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | ✅ | UTC date (YYYY-MM-DD) of the window upper bound (yesterday). Data is exclusive of the current incomplete UTC day. This is the expected latest date in the snapshot; it does not confirm data presence for that date. | 2026-06-17 | -| `Classifications` | [][components.TaskClassificationItem](../../models/components/taskclassificationitem.mdx) | ✅ | Per-task classification market-share data, sorted by usage_share descending. | | -| `MacroCategories` | [][components.TaskClassificationMacroCategory](../../models/components/taskclassificationmacrocategory.mdx) | ✅ | Aggregate market-share data per macro-category (code, data, agent, general). | | -| `WindowDays` | `int64` | ✅ | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file +| `AsOf` | `string` | :heavy_check_mark: | UTC date (YYYY-MM-DD) of the window upper bound (yesterday). Data is exclusive of the current incomplete UTC day. This is the expected latest date in the snapshot; it does not confirm data presence for that date. | 2026-06-17 | +| `Classifications` | [][components.TaskClassificationItem](../../models/components/taskclassificationitem.mdx) | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | +| `MacroCategories` | [][components.TaskClassificationMacroCategory](../../models/components/taskclassificationmacrocategory.mdx) | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | +| `WindowDays` | `int64` | :heavy_check_mark: | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file diff --git a/docs/models/components/textdeltaevent.mdx b/docs/models/components/textdeltaevent.mdx index 70295e2f9..a59e7d5a7 100644 --- a/docs/models/components/textdeltaevent.mdx +++ b/docs/models/components/textdeltaevent.mdx @@ -9,10 +9,10 @@ Event emitted when a text delta is streamed | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | ✅ | N/A | -| `Delta` | `string` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.TextDeltaEventType](../../models/components/textdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | +| `Delta` | `string` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.TextDeltaEventType](../../models/components/textdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/textdoneevent.mdx b/docs/models/components/textdoneevent.mdx index 13414eb8f..3f947ad4a 100644 --- a/docs/models/components/textdoneevent.mdx +++ b/docs/models/components/textdoneevent.mdx @@ -9,10 +9,10 @@ Event emitted when text streaming is complete | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | ✅ | N/A | -| `ItemID` | `string` | ✅ | N/A | -| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Text` | `string` | ✅ | N/A | -| `Type` | [components.TextDoneEventType](../../models/components/textdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.TextDoneEventType](../../models/components/textdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/textextendedconfig.mdx b/docs/models/components/textextendedconfig.mdx index 3770834cd..908cb333c 100644 --- a/docs/models/components/textextendedconfig.mdx +++ b/docs/models/components/textextendedconfig.mdx @@ -9,5 +9,5 @@ Text output configuration including format and verbosity | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Format` | [*components.Formats](../../models/components/formats.mdx) | ➖ | Text response format configuration | \{
"type": "text"
} | -| `Verbosity` | optionalnullable.OptionalNullable[[components.Verbosity](../../models/components/verbosity.mdx)] | ➖ | N/A | | \ No newline at end of file +| `Format` | [*components.Formats](../../models/components/formats.mdx) | :heavy_minus_sign: | Text response format configuration | \{
"type": "text"
} | +| `Verbosity` | optionalnullable.OptionalNullable[[components.Verbosity](../../models/components/verbosity.mdx)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/textgeneration.mdx b/docs/models/components/textgeneration.mdx index 5fb004bd2..6e8bb5af4 100644 --- a/docs/models/components/textgeneration.mdx +++ b/docs/models/components/textgeneration.mdx @@ -6,6 +6,6 @@ title: "TextGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/thinkingadaptive.mdx b/docs/models/components/thinkingadaptive.mdx index d61b08341..6fb273f81 100644 --- a/docs/models/components/thinkingadaptive.mdx +++ b/docs/models/components/thinkingadaptive.mdx @@ -6,6 +6,6 @@ title: "ThinkingAdaptive" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `BlockBinding` | optionalnullable.OptionalNullable[[components.AnthropicThinkingBlockBinding](../../models/components/anthropicthinkingblockbinding.mdx)] | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | ➖ | N/A | summarized | -| `Type` | [components.TypeAdaptive](../../models/components/typeadaptive.mdx) | ✅ | N/A | | \ No newline at end of file +| `BlockBinding` | optionalnullable.OptionalNullable[[components.AnthropicThinkingBlockBinding](../../models/components/anthropicthinkingblockbinding.mdx)] | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | :heavy_minus_sign: | N/A | summarized | +| `Type` | [components.TypeAdaptive](../../models/components/typeadaptive.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/thinkingbetweentools.mdx b/docs/models/components/thinkingbetweentools.mdx index 198f80cee..46973e9e6 100644 --- a/docs/models/components/thinkingbetweentools.mdx +++ b/docs/models/components/thinkingbetweentools.mdx @@ -6,4 +6,4 @@ title: "ThinkingBetweenTools" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Type` | [components.TypeBetweenTools](../../models/components/typebetweentools.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.TypeBetweenTools](../../models/components/typebetweentools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/thinkingdisabled.mdx b/docs/models/components/thinkingdisabled.mdx index c8b9b230a..22ded428c 100644 --- a/docs/models/components/thinkingdisabled.mdx +++ b/docs/models/components/thinkingdisabled.mdx @@ -6,4 +6,4 @@ title: "ThinkingDisabled" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.ThinkingTypeDisabled](../../models/components/thinkingtypedisabled.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.ThinkingTypeDisabled](../../models/components/thinkingtypedisabled.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/thinkingenabled.mdx b/docs/models/components/thinkingenabled.mdx index ee4e54d92..3688aa85d 100644 --- a/docs/models/components/thinkingenabled.mdx +++ b/docs/models/components/thinkingenabled.mdx @@ -6,7 +6,7 @@ title: "ThinkingEnabled" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `BlockBinding` | optionalnullable.OptionalNullable[[components.AnthropicThinkingBlockBinding](../../models/components/anthropicthinkingblockbinding.mdx)] | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `BudgetTokens` | `int64` | ✅ | N/A | | -| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | ➖ | N/A | summarized | -| `Type` | [components.TypeEnabled](../../models/components/typeenabled.mdx) | ✅ | N/A | | \ No newline at end of file +| `BlockBinding` | optionalnullable.OptionalNullable[[components.AnthropicThinkingBlockBinding](../../models/components/anthropicthinkingblockbinding.mdx)] | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `BudgetTokens` | `int64` | :heavy_check_mark: | N/A | | +| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | :heavy_minus_sign: | N/A | summarized | +| `Type` | [components.TypeEnabled](../../models/components/typeenabled.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/tokenexchangerequest.mdx b/docs/models/components/tokenexchangerequest.mdx index b3dea23e9..af5fa8f94 100644 --- a/docs/models/components/tokenexchangerequest.mdx +++ b/docs/models/components/tokenexchangerequest.mdx @@ -9,9 +9,9 @@ RFC 8693 token exchange request body (application/x-www-form-urlencoded). | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `FederationPolicyID` | `string` | ✅ | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | -| `GrantType` | [components.GrantType](../../models/components/granttype.mdx) | ✅ | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | -| `RequestedTokenType` | [*components.RequestedTokenType](../../models/components/requestedtokentype.mdx) | ➖ | Optional; when present must be `urn:ietf:params:oauth:token-type:access_token`. | urn:ietf:params:oauth:token-type:access_token | -| `Scope` | [*components.TokenExchangeRequestScope](../../models/components/tokenexchangerequestscope.mdx) | ➖ | Optional; only `inference` is available. | inference | -| `SubjectToken` | `string` | ✅ | The JWT issued by your identity provider. | \ | -| `SubjectTokenType` | [components.SubjectTokenType](../../models/components/subjecttokentype.mdx) | ✅ | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | \ No newline at end of file +| `FederationPolicyID` | `string` | :heavy_check_mark: | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | +| `GrantType` | [components.GrantType](../../models/components/granttype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | +| `RequestedTokenType` | [*components.RequestedTokenType](../../models/components/requestedtokentype.mdx) | :heavy_minus_sign: | Optional; when present must be `urn:ietf:params:oauth:token-type:access_token`. | urn:ietf:params:oauth:token-type:access_token | +| `Scope` | [*components.TokenExchangeRequestScope](../../models/components/tokenexchangerequestscope.mdx) | :heavy_minus_sign: | Optional; only `inference` is available. | inference | +| `SubjectToken` | `string` | :heavy_check_mark: | The JWT issued by your identity provider. | \ | +| `SubjectTokenType` | [components.SubjectTokenType](../../models/components/subjecttokentype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | \ No newline at end of file diff --git a/docs/models/components/tokenexchangeresponse.mdx b/docs/models/components/tokenexchangeresponse.mdx index dac50be35..c09a73525 100644 --- a/docs/models/components/tokenexchangeresponse.mdx +++ b/docs/models/components/tokenexchangeresponse.mdx @@ -9,8 +9,8 @@ RFC 8693 token exchange response. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `AccessToken` | `string` | ✅ | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | -| `ExpiresIn` | `int64` | ✅ | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | -| `IssuedTokenType` | [components.IssuedTokenType](../../models/components/issuedtokentype.mdx) | ✅ | N/A | urn:ietf:params:oauth:token-type:access_token | -| `Scope` | `string` | ✅ | N/A | inference | -| `TokenType` | [components.TokenType](../../models/components/tokentype.mdx) | ✅ | N/A | Bearer | \ No newline at end of file +| `AccessToken` | `string` | :heavy_check_mark: | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | +| `ExpiresIn` | `int64` | :heavy_check_mark: | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | +| `IssuedTokenType` | [components.IssuedTokenType](../../models/components/issuedtokentype.mdx) | :heavy_check_mark: | N/A | urn:ietf:params:oauth:token-type:access_token | +| `Scope` | `string` | :heavy_check_mark: | N/A | inference | +| `TokenType` | [components.TokenType](../../models/components/tokentype.mdx) | :heavy_check_mark: | N/A | Bearer | \ No newline at end of file diff --git a/docs/models/components/tooladvisor20260301.mdx b/docs/models/components/tooladvisor20260301.mdx index f48ca1fc9..7f6556104 100644 --- a/docs/models/components/tooladvisor20260301.mdx +++ b/docs/models/components/tooladvisor20260301.mdx @@ -6,11 +6,11 @@ title: "ToolAdvisor20260301" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | ➖ | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Caching` | optionalnullable.OptionalNullable[[components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx)] | ➖ | N/A | \{
"type": "ephemeral"
} | -| `DeferLoading` | `*bool` | ➖ | N/A | | -| `MaxUses` | `*int64` | ➖ | N/A | | -| `Model` | `string` | ✅ | N/A | | -| `Name` | [components.NameAdvisor](../../models/components/nameadvisor.mdx) | ✅ | N/A | | -| `Type` | [components.TypeAdvisor20260301](../../models/components/typeadvisor20260301.mdx) | ✅ | N/A | | \ No newline at end of file +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Caching` | optionalnullable.OptionalNullable[[components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | +| `MaxUses` | `*int64` | :heavy_minus_sign: | N/A | | +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `Name` | [components.NameAdvisor](../../models/components/nameadvisor.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeAdvisor20260301](../../models/components/typeadvisor20260301.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolbash20250124.mdx b/docs/models/components/toolbash20250124.mdx index 65528022e..6b1fa0de6 100644 --- a/docs/models/components/toolbash20250124.mdx +++ b/docs/models/components/toolbash20250124.mdx @@ -6,6 +6,6 @@ title: "ToolBash20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Name` | [components.NameBash](../../models/components/namebash.mdx) | ✅ | N/A | | -| `Type` | [components.TypeBash20250124](../../models/components/typebash20250124.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Name` | [components.NameBash](../../models/components/namebash.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeBash20250124](../../models/components/typebash20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolcall.mdx b/docs/models/components/toolcall.mdx index 7309e9b58..3ba8d0f95 100644 --- a/docs/models/components/toolcall.mdx +++ b/docs/models/components/toolcall.mdx @@ -6,7 +6,7 @@ title: "ToolCall" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Function` | [components.BatchObjectFunction](../../models/components/batchobjectfunction.mdx) | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Index` | `int64` | ✅ | N/A | -| `Type` | [components.ChoiceTypeFunction](../../models/components/choicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file +| `Function` | [components.BatchObjectFunction](../../models/components/batchobjectfunction.mdx) | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Index` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.ChoiceTypeFunction](../../models/components/choicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoiceallowed.mdx b/docs/models/components/toolchoiceallowed.mdx index 76e8cc3ef..39e02a062 100644 --- a/docs/models/components/toolchoiceallowed.mdx +++ b/docs/models/components/toolchoiceallowed.mdx @@ -9,6 +9,6 @@ Constrains the model to a pre-defined set of allowed tools | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Mode` | [components.Mode](../../models/components/mode.mdx) | ✅ | N/A | -| `Tools` | []map[string]`any` | ✅ | N/A | -| `Type` | [components.ToolChoiceAllowedType](../../models/components/toolchoiceallowedtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Mode` | [components.Mode](../../models/components/mode.mdx) | :heavy_check_mark: | N/A | +| `Tools` | []map[string]`any` | :heavy_check_mark: | N/A | +| `Type` | [components.ToolChoiceAllowedType](../../models/components/toolchoiceallowedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoiceany.mdx b/docs/models/components/toolchoiceany.mdx index e0bf54b3c..0896d1577 100644 --- a/docs/models/components/toolchoiceany.mdx +++ b/docs/models/components/toolchoiceany.mdx @@ -6,5 +6,5 @@ title: "ToolChoiceAny" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `DisableParallelToolUse` | `*bool` | ➖ | N/A | -| `Type` | [components.TypeAny](../../models/components/typeany.mdx) | ✅ | N/A | \ No newline at end of file +| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | +| `Type` | [components.TypeAny](../../models/components/typeany.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoiceauto.mdx b/docs/models/components/toolchoiceauto.mdx index 61a434777..41a391880 100644 --- a/docs/models/components/toolchoiceauto.mdx +++ b/docs/models/components/toolchoiceauto.mdx @@ -6,5 +6,5 @@ title: "ToolChoiceAuto" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `DisableParallelToolUse` | `*bool` | ➖ | N/A | -| `Type` | [components.ToolChoiceTypeAuto](../../models/components/toolchoicetypeauto.mdx) | ✅ | N/A | \ No newline at end of file +| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | +| `Type` | [components.ToolChoiceTypeAuto](../../models/components/toolchoicetypeauto.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoicenone.mdx b/docs/models/components/toolchoicenone.mdx index 4a0dc016a..0b431b9a6 100644 --- a/docs/models/components/toolchoicenone.mdx +++ b/docs/models/components/toolchoicenone.mdx @@ -6,4 +6,4 @@ title: "ToolChoiceNone" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Type` | [components.TypeNone](../../models/components/typenone.mdx) | ✅ | N/A | \ No newline at end of file +| `Type` | [components.TypeNone](../../models/components/typenone.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoicesupport.mdx b/docs/models/components/toolchoicesupport.mdx index 0ddd26b8f..682bee4e9 100644 --- a/docs/models/components/toolchoicesupport.mdx +++ b/docs/models/components/toolchoicesupport.mdx @@ -9,7 +9,7 @@ Per-variant `tool_choice` support. `tool_choice` in `supported_parameters` only | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Auto` | `bool` | ✅ | Whether the endpoint supports `"tool_choice": "auto"`. | -| `Function` | `bool` | ✅ | Whether the endpoint supports naming a function, `"tool_choice": {"type": "function", ...}`. | -| `None` | `bool` | ✅ | Whether the endpoint supports `"tool_choice": "none"`. | -| `Required` | `bool` | ✅ | Whether the endpoint supports `"tool_choice": "required"`. | \ No newline at end of file +| `Auto` | `bool` | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "auto"`. | +| `Function` | `bool` | :heavy_check_mark: | Whether the endpoint supports naming a function, `"tool_choice": {"type": "function", ...}`. | +| `None` | `bool` | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "none"`. | +| `Required` | `bool` | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "required"`. | \ No newline at end of file diff --git a/docs/models/components/toolchoicetool.mdx b/docs/models/components/toolchoicetool.mdx index d666dad76..42539fc3e 100644 --- a/docs/models/components/toolchoicetool.mdx +++ b/docs/models/components/toolchoicetool.mdx @@ -6,6 +6,6 @@ title: "ToolChoiceTool" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `DisableParallelToolUse` | `*bool` | ➖ | N/A | -| `Name` | `string` | ✅ | N/A | -| `Type` | [components.TypeTool](../../models/components/typetool.mdx) | ✅ | N/A | \ No newline at end of file +| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.TypeTool](../../models/components/typetool.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolcustom.mdx b/docs/models/components/toolcustom.mdx index f7e23ae5f..8b8aabd4d 100644 --- a/docs/models/components/toolcustom.mdx +++ b/docs/models/components/toolcustom.mdx @@ -6,10 +6,10 @@ title: "ToolCustom" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `DeferLoading` | `*bool` | ➖ | N/A | | -| `Description` | `*string` | ➖ | N/A | | -| `InputSchema` | [components.InputSchema](../../models/components/inputschema.mdx) | ✅ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Strict` | `*bool` | ➖ | N/A | | -| `Type` | [*components.ToolTypeCustom](../../models/components/tooltypecustom.mdx) | ➖ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | +| `Description` | `*string` | :heavy_minus_sign: | N/A | | +| `InputSchema` | [components.InputSchema](../../models/components/inputschema.mdx) | :heavy_check_mark: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Strict` | `*bool` | :heavy_minus_sign: | N/A | | +| `Type` | [*components.ToolTypeCustom](../../models/components/tooltypecustom.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolsearchcallitem.mdx b/docs/models/components/toolsearchcallitem.mdx index 46dd8ead6..27a27b2fa 100644 --- a/docs/models/components/toolsearchcallitem.mdx +++ b/docs/models/components/toolsearchcallitem.mdx @@ -9,9 +9,9 @@ A tool search call the client executed | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `any` | ➖ | N/A | -| `CallID` | `string` | ✅ | N/A | -| `Execution` | [components.ToolSearchCallItemExecution](../../models/components/toolsearchcallitemexecution.mdx) | ✅ | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Status` | optionalnullable.OptionalNullable[[components.ToolSearchCallItemStatus](../../models/components/toolsearchcallitemstatus.mdx)] | ➖ | N/A | -| `Type` | [components.ToolSearchCallItemType](../../models/components/toolsearchcallitemtype.mdx) | ✅ | N/A | \ No newline at end of file +| `Arguments` | `any` | :heavy_minus_sign: | N/A | +| `CallID` | `string` | :heavy_check_mark: | N/A | +| `Execution` | [components.ToolSearchCallItemExecution](../../models/components/toolsearchcallitemexecution.mdx) | :heavy_check_mark: | N/A | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Status` | optionalnullable.OptionalNullable[[components.ToolSearchCallItemStatus](../../models/components/toolsearchcallitemstatus.mdx)] | :heavy_minus_sign: | N/A | +| `Type` | [components.ToolSearchCallItemType](../../models/components/toolsearchcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolsearchoutputitem.mdx b/docs/models/components/toolsearchoutputitem.mdx index 27526276f..acb5494c9 100644 --- a/docs/models/components/toolsearchoutputitem.mdx +++ b/docs/models/components/toolsearchoutputitem.mdx @@ -9,9 +9,9 @@ The tools a client-executed tool search loaded | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | ✅ | N/A | -| `Execution` | [components.ToolSearchOutputItemExecution](../../models/components/toolsearchoutputitemexecution.mdx) | ✅ | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Status` | optionalnullable.OptionalNullable[[components.ToolSearchOutputItemStatus](../../models/components/toolsearchoutputitemstatus.mdx)] | ➖ | N/A | -| `Tools` | [][components.ToolSearchOutputItemToolUnion](../../models/components/toolsearchoutputitemtoolunion.mdx) | ✅ | N/A | -| `Type` | [components.TypeToolSearchOutput](../../models/components/typetoolsearchoutput.mdx) | ✅ | N/A | \ No newline at end of file +| `CallID` | `string` | :heavy_check_mark: | N/A | +| `Execution` | [components.ToolSearchOutputItemExecution](../../models/components/toolsearchoutputitemexecution.mdx) | :heavy_check_mark: | N/A | +| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Status` | optionalnullable.OptionalNullable[[components.ToolSearchOutputItemStatus](../../models/components/toolsearchoutputitemstatus.mdx)] | :heavy_minus_sign: | N/A | +| `Tools` | [][components.ToolSearchOutputItemToolUnion](../../models/components/toolsearchoutputitemtoolunion.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeToolSearchOutput](../../models/components/typetoolsearchoutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolsearchoutputitemtool.mdx b/docs/models/components/toolsearchoutputitemtool.mdx index 1998f90de..fb1397335 100644 --- a/docs/models/components/toolsearchoutputitemtool.mdx +++ b/docs/models/components/toolsearchoutputitemtool.mdx @@ -6,5 +6,5 @@ title: "ToolSearchOutputItemTool" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | ✅ | N/A | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Type` | `string` | :heavy_check_mark: | N/A | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolsearchoutputitemtoolfunction.mdx b/docs/models/components/toolsearchoutputitemtoolfunction.mdx index 02112f21f..93783a9a9 100644 --- a/docs/models/components/toolsearchoutputitemtoolfunction.mdx +++ b/docs/models/components/toolsearchoutputitemtoolfunction.mdx @@ -9,10 +9,10 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | -| `Name` | `string` | ✅ | N/A | | -| `Parameters` | map[string]`any` | ✅ | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | -| `Type` | [components.ToolSearchOutputItemTypeFunction](../../models/components/toolsearchoutputitemtypefunction.mdx) | ✅ | N/A | | -| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | +| `Name` | `string` | :heavy_check_mark: | N/A | | +| `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | +| `Type` | [components.ToolSearchOutputItemTypeFunction](../../models/components/toolsearchoutputitemtypefunction.mdx) | :heavy_check_mark: | N/A | | +| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/components/toolsearchservertool.mdx b/docs/models/components/toolsearchservertool.mdx index 466ee3476..39e574fea 100644 --- a/docs/models/components/toolsearchservertool.mdx +++ b/docs/models/components/toolsearchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: finds tools marked `defer_loading` and makes th | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ToolSearchServerToolConfig](../../models/components/toolsearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | -| `Type` | [components.ToolSearchServerToolType](../../models/components/toolsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.ToolSearchServerToolConfig](../../models/components/toolsearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | +| `Type` | [components.ToolSearchServerToolType](../../models/components/toolsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolsearchservertoolconfig.mdx b/docs/models/components/toolsearchservertoolconfig.mdx index 7a0423737..85ad9eb81 100644 --- a/docs/models/components/toolsearchservertoolconfig.mdx +++ b/docs/models/components/toolsearchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:tool_search server tool | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `MaxResults` | `*int64` | ➖ | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file diff --git a/docs/models/components/tooltexteditor20250124.mdx b/docs/models/components/tooltexteditor20250124.mdx index c8a0aecad..5ae15508a 100644 --- a/docs/models/components/tooltexteditor20250124.mdx +++ b/docs/models/components/tooltexteditor20250124.mdx @@ -6,6 +6,6 @@ title: "ToolTextEditor20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Name` | [components.NameStrReplaceEditor](../../models/components/namestrreplaceeditor.mdx) | ✅ | N/A | | -| `Type` | [components.TypeTextEditor20250124](../../models/components/typetexteditor20250124.mdx) | ✅ | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Name` | [components.NameStrReplaceEditor](../../models/components/namestrreplaceeditor.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeTextEditor20250124](../../models/components/typetexteditor20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolwebsearch20250305.mdx b/docs/models/components/toolwebsearch20250305.mdx index de6f69078..a3da68845 100644 --- a/docs/models/components/toolwebsearch20250305.mdx +++ b/docs/models/components/toolwebsearch20250305.mdx @@ -6,10 +6,10 @@ title: "ToolWebSearch20250305" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | -| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | -| `Name` | [components.NameWebSearch1](../../models/components/namewebsearch1.mdx) | ✅ | N/A | | -| `Type` | [components.TypeWebSearch20250305](../../models/components/typewebsearch20250305.mdx) | ✅ | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | +| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | +| `Name` | [components.NameWebSearch1](../../models/components/namewebsearch1.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeWebSearch20250305](../../models/components/typewebsearch20250305.mdx) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/toolwebsearch20260209.mdx b/docs/models/components/toolwebsearch20260209.mdx index 3b8431f3b..0526f22d0 100644 --- a/docs/models/components/toolwebsearch20260209.mdx +++ b/docs/models/components/toolwebsearch20260209.mdx @@ -6,11 +6,11 @@ title: "ToolWebSearch20260209" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | ➖ | N/A | [
"direct"
] | -| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | -| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | -| `Name` | [components.NameWebSearch2](../../models/components/namewebsearch2.mdx) | ✅ | N/A | | -| `Type` | [components.TypeWebSearch20260209](../../models/components/typewebsearch20260209.mdx) | ✅ | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | +| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | +| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | +| `Name` | [components.NameWebSearch2](../../models/components/namewebsearch2.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeWebSearch20260209](../../models/components/typewebsearch20260209.mdx) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/toomanyrequestsresponseerrordata.mdx b/docs/models/components/toomanyrequestsresponseerrordata.mdx index 617765ea4..dba2348b9 100644 --- a/docs/models/components/toomanyrequestsresponseerrordata.mdx +++ b/docs/models/components/toomanyrequestsresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for TooManyRequestsResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/topproviderinfo.mdx b/docs/models/components/topproviderinfo.mdx index 9c35d9d65..0a9ae8f98 100644 --- a/docs/models/components/topproviderinfo.mdx +++ b/docs/models/components/topproviderinfo.mdx @@ -9,6 +9,6 @@ Information about the top provider for this model | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContextLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | Context length from the top provider | 8192 | -| `IsModerated` | `bool` | ✅ | Whether the top provider moderates content | true | -| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum completion tokens from the top provider. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | 4096 | \ No newline at end of file +| `ContextLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Context length from the top provider | 8192 | +| `IsModerated` | `bool` | :heavy_check_mark: | Whether the top provider moderates content | true | +| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum completion tokens from the top provider. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | 4096 | \ No newline at end of file diff --git a/docs/models/components/tournamentstats.mdx b/docs/models/components/tournamentstats.mdx index d08896a01..02e336b83 100644 --- a/docs/models/components/tournamentstats.mdx +++ b/docs/models/components/tournamentstats.mdx @@ -9,8 +9,8 @@ Placement distribution from tournament matches. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `FirstPlace` | `*int64` | ✅ | N/A | -| `FourthPlace` | `*int64` | ✅ | N/A | -| `SecondPlace` | `*int64` | ✅ | N/A | -| `ThirdPlace` | `*int64` | ✅ | N/A | -| `Total` | `*int64` | ✅ | N/A | \ No newline at end of file +| `FirstPlace` | `*int64` | :heavy_check_mark: | N/A | +| `FourthPlace` | `*int64` | :heavy_check_mark: | N/A | +| `SecondPlace` | `*int64` | :heavy_check_mark: | N/A | +| `ThirdPlace` | `*int64` | :heavy_check_mark: | N/A | +| `Total` | `*int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/traceconfig.mdx b/docs/models/components/traceconfig.mdx index 136352cd4..2ee049277 100644 --- a/docs/models/components/traceconfig.mdx +++ b/docs/models/components/traceconfig.mdx @@ -9,9 +9,9 @@ Metadata for observability and tracing. Known keys (trace_id, trace_name, span_n | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `GenerationName` | `*string` | ➖ | N/A | | -| `ParentSpanID` | `*string` | ➖ | N/A | | -| `SpanName` | `*string` | ➖ | N/A | | -| `TraceID` | `*string` | ➖ | N/A | | -| `TraceName` | `*string` | ➖ | N/A | | -| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file +| `GenerationName` | `*string` | :heavy_minus_sign: | N/A | | +| `ParentSpanID` | `*string` | :heavy_minus_sign: | N/A | | +| `SpanName` | `*string` | :heavy_minus_sign: | N/A | | +| `TraceID` | `*string` | :heavy_minus_sign: | N/A | | +| `TraceName` | `*string` | :heavy_minus_sign: | N/A | | +| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file diff --git a/docs/models/components/triggerinputtokens.mdx b/docs/models/components/triggerinputtokens.mdx index 790379a6e..c03547aba 100644 --- a/docs/models/components/triggerinputtokens.mdx +++ b/docs/models/components/triggerinputtokens.mdx @@ -6,5 +6,5 @@ title: "TriggerInputTokens" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.EditTypeInputTokens](../../models/components/edittypeinputtokens.mdx) | ✅ | N/A | -| `Value` | `int64` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.EditTypeInputTokens](../../models/components/edittypeinputtokens.mdx) | :heavy_check_mark: | N/A | +| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/tts.mdx b/docs/models/components/tts.mdx index a790919df..7a80a19af 100644 --- a/docs/models/components/tts.mdx +++ b/docs/models/components/tts.mdx @@ -6,6 +6,6 @@ title: "TTS" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/unauthorizedresponseerrordata.mdx b/docs/models/components/unauthorizedresponseerrordata.mdx index 170b1c8ba..aec056179 100644 --- a/docs/models/components/unauthorizedresponseerrordata.mdx +++ b/docs/models/components/unauthorizedresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for UnauthorizedResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarkpricing.mdx b/docs/models/components/unifiedbenchmarkpricing.mdx index b08151ce3..d04711bcb 100644 --- a/docs/models/components/unifiedbenchmarkpricing.mdx +++ b/docs/models/components/unifiedbenchmarkpricing.mdx @@ -9,5 +9,5 @@ OpenRouter pricing per token for this model. Null if pricing is unavailable. | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `Completion` | `string` | ✅ | Cost per output token (USD, decimal string). | 0.000015 | -| `Prompt` | `string` | ✅ | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file +| `Completion` | `string` | :heavy_check_mark: | Cost per output token (USD, decimal string). | 0.000015 | +| `Prompt` | `string` | :heavy_check_mark: | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksaaitem.mdx b/docs/models/components/unifiedbenchmarksaaitem.mdx index 121e4b799..232deb499 100644 --- a/docs/models/components/unifiedbenchmarksaaitem.mdx +++ b/docs/models/components/unifiedbenchmarksaaitem.mdx @@ -6,10 +6,10 @@ title: "UnifiedBenchmarksAAItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `AgenticIndex` | `*float64` | ✅ | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | -| `CodingIndex` | `*float64` | ✅ | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | -| `DisplayName` | `string` | ✅ | Model name as listed on Artificial Analysis. | GPT-4o | -| `IntelligenceIndex` | `*float64` | ✅ | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | -| `ModelPermaslug` | `string` | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | -| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `Source` | [components.UnifiedBenchmarksAAItemSource](../../models/components/unifiedbenchmarksaaitemsource.mdx) | ✅ | Benchmark source discriminator. | | \ No newline at end of file +| `AgenticIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | +| `CodingIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | +| `DisplayName` | `string` | :heavy_check_mark: | Model name as listed on Artificial Analysis. | GPT-4o | +| `IntelligenceIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | +| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `Source` | [components.UnifiedBenchmarksAAItemSource](../../models/components/unifiedbenchmarksaaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksdaitem.mdx b/docs/models/components/unifiedbenchmarksdaitem.mdx index 2179eb261..e55838118 100644 --- a/docs/models/components/unifiedbenchmarksdaitem.mdx +++ b/docs/models/components/unifiedbenchmarksdaitem.mdx @@ -6,13 +6,13 @@ title: "UnifiedBenchmarksDAItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Arena` | `string` | ✅ | Arena this ranking belongs to. | models | -| `AvgGenerationTimeMs` | `*float64` | ✅ | Average generation time in milliseconds. | 3200 | -| `Category` | `string` | ✅ | Category within the arena. | codecategories | -| `DisplayName` | `string` | ✅ | Human-readable model name from Design Arena. | Claude Sonnet 4 | -| `Elo` | `float64` | ✅ | ELO rating from head-to-head arena battles. | 1423 | -| `ModelPermaslug` | `string` | ✅ | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | -| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `Source` | [components.UnifiedBenchmarksDAItemSource](../../models/components/unifiedbenchmarksdaitemsource.mdx) | ✅ | Benchmark source discriminator. | | -| `TournamentStats` | [components.TournamentStats](../../models/components/tournamentstats.mdx) | ✅ | Placement distribution from tournament matches. | | -| `WinRate` | `float64` | ✅ | Win rate as a percentage (0–100). | 72 | \ No newline at end of file +| `Arena` | `string` | :heavy_check_mark: | Arena this ranking belongs to. | models | +| `AvgGenerationTimeMs` | `*float64` | :heavy_check_mark: | Average generation time in milliseconds. | 3200 | +| `Category` | `string` | :heavy_check_mark: | Category within the arena. | codecategories | +| `DisplayName` | `string` | :heavy_check_mark: | Human-readable model name from Design Arena. | Claude Sonnet 4 | +| `Elo` | `float64` | :heavy_check_mark: | ELO rating from head-to-head arena battles. | 1423 | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | +| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `Source` | [components.UnifiedBenchmarksDAItemSource](../../models/components/unifiedbenchmarksdaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | +| `TournamentStats` | [components.TournamentStats](../../models/components/tournamentstats.mdx) | :heavy_check_mark: | Placement distribution from tournament matches. | | +| `WinRate` | `float64` | :heavy_check_mark: | Win rate as a percentage (0–100). | 72 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksmeta.mdx b/docs/models/components/unifiedbenchmarksmeta.mdx index 5e4f54e6c..d5e63e719 100644 --- a/docs/models/components/unifiedbenchmarksmeta.mdx +++ b/docs/models/components/unifiedbenchmarksmeta.mdx @@ -6,10 +6,10 @@ title: "UnifiedBenchmarksMeta" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | ✅ | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | -| `Citation` | `*string` | ✅ | Required attribution when republishing this data, or null when results span multiple sources (attribute each item individually by its `source` discriminator). | Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings). | -| `ModelCount` | `int64` | ✅ | Number of unique models in the response. | | -| `Source` | [*components.UnifiedBenchmarksMetaSource](../../models/components/unifiedbenchmarksmetasource.mdx) | ✅ | The source filter applied, or null when all sources are returned. | artificial-analysis | -| `SourceURL` | `*string` | ✅ | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | -| `TaskType` | `*string` | ✅ | The task_type filter applied, or null if showing all. | | -| `Version` | [components.UnifiedBenchmarksMetaVersion](../../models/components/unifiedbenchmarksmetaversion.mdx) | ✅ | Dataset version. | | \ No newline at end of file +| `AsOf` | `string` | :heavy_check_mark: | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | +| `Citation` | `*string` | :heavy_check_mark: | Required attribution when republishing this data, or null when results span multiple sources (attribute each item individually by its `source` discriminator). | Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings). | +| `ModelCount` | `int64` | :heavy_check_mark: | Number of unique models in the response. | | +| `Source` | [*components.UnifiedBenchmarksMetaSource](../../models/components/unifiedbenchmarksmetasource.mdx) | :heavy_check_mark: | The source filter applied, or null when all sources are returned. | artificial-analysis | +| `SourceURL` | `*string` | :heavy_check_mark: | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | +| `TaskType` | `*string` | :heavy_check_mark: | The task_type filter applied, or null if showing all. | | +| `Version` | [components.UnifiedBenchmarksMetaVersion](../../models/components/unifiedbenchmarksmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksoritem.mdx b/docs/models/components/unifiedbenchmarksoritem.mdx index 66d1cfbe3..5d1f40d95 100644 --- a/docs/models/components/unifiedbenchmarksoritem.mdx +++ b/docs/models/components/unifiedbenchmarksoritem.mdx @@ -6,12 +6,12 @@ title: "UnifiedBenchmarksORItem" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Accuracy` | `float64` | ✅ | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | -| `AccuracyStddev` | `*float64` | ✅ | Standard deviation of run accuracy, or null for a single run. | 0.03 | -| `AvgCostPerTask` | `*float64` | ✅ | Average cost per task in USD, or null if unavailable. | 0.002 | -| `BenchmarkType` | [components.UnifiedBenchmarksORItemBenchmarkType](../../models/components/unifiedbenchmarksoritembenchmarktype.mdx) | ✅ | OpenRouter benchmark evaluation type. | gpqa_diamond | -| `DisplayName` | `string` | ✅ | Human-readable model name. | GPT-4o | -| `LastRunTimestamp` | `string` | ✅ | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | -| `ModelPermaslug` | `string` | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | -| `Source` | [components.UnifiedBenchmarksORItemSource](../../models/components/unifiedbenchmarksoritemsource.mdx) | ✅ | Benchmark source discriminator. | | -| `TotalTasks` | `int64` | ✅ | Total benchmark tasks across runs. | 300 | \ No newline at end of file +| `Accuracy` | `float64` | :heavy_check_mark: | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | +| `AccuracyStddev` | `*float64` | :heavy_check_mark: | Standard deviation of run accuracy, or null for a single run. | 0.03 | +| `AvgCostPerTask` | `*float64` | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.002 | +| `BenchmarkType` | [components.UnifiedBenchmarksORItemBenchmarkType](../../models/components/unifiedbenchmarksoritembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter benchmark evaluation type. | gpqa_diamond | +| `DisplayName` | `string` | :heavy_check_mark: | Human-readable model name. | GPT-4o | +| `LastRunTimestamp` | `string` | :heavy_check_mark: | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | +| `Source` | [components.UnifiedBenchmarksORItemSource](../../models/components/unifiedbenchmarksoritemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | +| `TotalTasks` | `int64` | :heavy_check_mark: | Total benchmark tasks across runs. | 300 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksresponse.mdx b/docs/models/components/unifiedbenchmarksresponse.mdx index 8beed06dd..d3443764d 100644 --- a/docs/models/components/unifiedbenchmarksresponse.mdx +++ b/docs/models/components/unifiedbenchmarksresponse.mdx @@ -6,5 +6,5 @@ title: "UnifiedBenchmarksResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.UnifiedBenchmarksResponseData](../../models/components/unifiedbenchmarksresponsedata.mdx) | ✅ | N/A | | -| `Meta` | [components.UnifiedBenchmarksMeta](../../models/components/unifiedbenchmarksmeta.mdx) | ✅ | N/A | \{
"as_of": "2026-06-03T12:00:00Z",
"citation": "Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings).",
"model_count": 50,
"source": "artificial-analysis",
"source_url": "https://artificialanalysis.ai",
"task_type": null,
"version": "v1"
} | \ No newline at end of file +| `Data` | [][components.UnifiedBenchmarksResponseData](../../models/components/unifiedbenchmarksresponsedata.mdx) | :heavy_check_mark: | N/A | | +| `Meta` | [components.UnifiedBenchmarksMeta](../../models/components/unifiedbenchmarksmeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-06-03T12:00:00Z",
"citation": "Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings).",
"model_count": 50,
"source": "artificial-analysis",
"source_url": "https://artificialanalysis.ai",
"task_type": null,
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarkssearchitem.mdx b/docs/models/components/unifiedbenchmarkssearchitem.mdx index cdc0d75c8..248720a06 100644 --- a/docs/models/components/unifiedbenchmarkssearchitem.mdx +++ b/docs/models/components/unifiedbenchmarkssearchitem.mdx @@ -6,16 +6,16 @@ title: "UnifiedBenchmarksSearchItem" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AvgCostPerTask` | `*float64` | ✅ | Average cost per task in USD, or null if unavailable. | 0.031 | -| `AvgLatencyPerTaskMs` | `*float64` | ✅ | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | -| `BenchmarkType` | [components.UnifiedBenchmarksSearchItemBenchmarkType](../../models/components/unifiedbenchmarkssearchitembenchmarktype.mdx) | ✅ | OpenRouter search benchmark. | search_browsecomp | -| `DisplayName` | `string` | ✅ | Human-readable model name. | GPT-4o | -| `LastRunTimestamp` | `string` | ✅ | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | -| `ModelPermaslug` | `string` | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | -| `PrimaryMetric` | [components.PrimaryMetric](../../models/components/primarymetric.mdx) | ✅ | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | -| `PrimaryScore` | `float64` | ✅ | The benchmark's headline score from 0 to 1. Its meaning is identified by `primary_metric`: item-weighted F1 for WideSearch or strict accuracy for the other search benchmarks. Higher is better. | 0.72 | -| `RunConfig` | [*components.UnifiedBenchmarksSearchRunConfig](../../models/components/unifiedbenchmarkssearchrunconfig.mdx) | ➖ | Published lane configuration, included only when include_run_config=true. Only the agent turn count, reasoning effort, and temperature are exposed; other harness settings are intentionally not part of the public contract. | | -| `SearchEngine` | `string` | ✅ | Search engine the published configuration used. | exa | -| `SearchSurface` | [components.SearchSurface](../../models/components/searchsurface.mdx) | ✅ | Request surface the published configuration went through. | server-tool | -| `Source` | [components.UnifiedBenchmarksSearchItemSource](../../models/components/unifiedbenchmarkssearchitemsource.mdx) | ✅ | Benchmark source discriminator. | | -| `TotalTasks` | `int64` | ✅ | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file +| `AvgCostPerTask` | `*float64` | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.031 | +| `AvgLatencyPerTaskMs` | `*float64` | :heavy_check_mark: | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | +| `BenchmarkType` | [components.UnifiedBenchmarksSearchItemBenchmarkType](../../models/components/unifiedbenchmarkssearchitembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter search benchmark. | search_browsecomp | +| `DisplayName` | `string` | :heavy_check_mark: | Human-readable model name. | GPT-4o | +| `LastRunTimestamp` | `string` | :heavy_check_mark: | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | +| `ModelPermaslug` | `string` | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | +| `PrimaryMetric` | [components.PrimaryMetric](../../models/components/primarymetric.mdx) | :heavy_check_mark: | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | +| `PrimaryScore` | `float64` | :heavy_check_mark: | The benchmark's headline score from 0 to 1. Its meaning is identified by `primary_metric`: item-weighted F1 for WideSearch or strict accuracy for the other search benchmarks. Higher is better. | 0.72 | +| `RunConfig` | [*components.UnifiedBenchmarksSearchRunConfig](../../models/components/unifiedbenchmarkssearchrunconfig.mdx) | :heavy_minus_sign: | Published lane configuration, included only when include_run_config=true. Only the agent turn count, reasoning effort, and temperature are exposed; other harness settings are intentionally not part of the public contract. | | +| `SearchEngine` | `string` | :heavy_check_mark: | Search engine the published configuration used. | exa | +| `SearchSurface` | [components.SearchSurface](../../models/components/searchsurface.mdx) | :heavy_check_mark: | Request surface the published configuration went through. | server-tool | +| `Source` | [components.UnifiedBenchmarksSearchItemSource](../../models/components/unifiedbenchmarkssearchitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | +| `TotalTasks` | `int64` | :heavy_check_mark: | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarkssearchrunconfig.mdx b/docs/models/components/unifiedbenchmarkssearchrunconfig.mdx index 8ad4d2ce9..50709bd96 100644 --- a/docs/models/components/unifiedbenchmarkssearchrunconfig.mdx +++ b/docs/models/components/unifiedbenchmarkssearchrunconfig.mdx @@ -9,6 +9,6 @@ Published lane configuration, included only when include_run_config=true. Only t | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `MaxAgentTurns` | `*int64` | ✅ | Agent-turn count for the published lane, or null for plugin lanes. | 25 | -| `ReasoningEffort` | `*string` | ✅ | Reasoning effort configured for the published lane, or null when omitted. | high | -| `Temperature` | `*float64` | ✅ | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file +| `MaxAgentTurns` | `*int64` | :heavy_check_mark: | Agent-turn count for the published lane, or null for plugin lanes. | 25 | +| `ReasoningEffort` | `*string` | :heavy_check_mark: | Reasoning effort configured for the published lane, or null when omitted. | high | +| `Temperature` | `*float64` | :heavy_check_mark: | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file diff --git a/docs/models/components/uniqueinsight.mdx b/docs/models/components/uniqueinsight.mdx index f60bbe32b..859d7df5d 100644 --- a/docs/models/components/uniqueinsight.mdx +++ b/docs/models/components/uniqueinsight.mdx @@ -6,5 +6,5 @@ title: "UniqueInsight" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Insight` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | \ No newline at end of file +| `Insight` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/unknown.mdx b/docs/models/components/unknown.mdx index 42d05d7d1..1c8d06f12 100644 --- a/docs/models/components/unknown.mdx +++ b/docs/models/components/unknown.mdx @@ -6,6 +6,6 @@ title: "Unknown" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/unprocessableentityresponseerrordata.mdx b/docs/models/components/unprocessableentityresponseerrordata.mdx index 6683f0647..10793193d 100644 --- a/docs/models/components/unprocessableentityresponseerrordata.mdx +++ b/docs/models/components/unprocessableentityresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for UnprocessableEntityResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | ✅ | N/A | -| `Message` | `string` | ✅ | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file +| `Code` | `int64` | :heavy_check_mark: | N/A | +| `Message` | `string` | :heavy_check_mark: | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/updatebyokkeyrequest.mdx b/docs/models/components/updatebyokkeyrequest.mdx index e3a70dc0d..ca7ff75fa 100644 --- a/docs/models/components/updatebyokkeyrequest.mdx +++ b/docs/models/components/updatebyokkeyrequest.mdx @@ -6,14 +6,14 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedAPIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.UpdateBYOKKeyRequestDeclaredRegion](../../models/components/updatebyokkeyrequestdeclaredregion.mdx)] | ➖ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Omit to leave the stored value unchanged (rotating an OpenAI or Fireworks `key` re-derives it from the new key); `null` clears the declaration. | null | -| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Omit to leave the stored value unchanged; `null` clears the declaration. | null | -| `Disabled` | `*bool` | ➖ | Whether this credential is disabled. | false | -| `IsBYOKOnly` | `*bool` | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Omit to leave the stored value unchanged. | false | -| `IsFallback` | `*bool` | ➖ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. Omit to leave the stored value unchanged. | false | -| `IsRequired` | `*bool` | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Omit to leave the stored value unchanged. | false | -| `Key` | `*string` | ➖ | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | -| `Name` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file +| `AllowedAPIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.UpdateBYOKKeyRequestDeclaredRegion](../../models/components/updatebyokkeyrequestdeclaredregion.mdx)] | :heavy_minus_sign: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Omit to leave the stored value unchanged (rotating an OpenAI or Fireworks `key` re-derives it from the new key); `null` clears the declaration. | null | +| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Omit to leave the stored value unchanged; `null` clears the declaration. | null | +| `Disabled` | `*bool` | :heavy_minus_sign: | Whether this credential is disabled. | false | +| `IsBYOKOnly` | `*bool` | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Omit to leave the stored value unchanged. | false | +| `IsFallback` | `*bool` | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. Omit to leave the stored value unchanged. | false | +| `IsRequired` | `*bool` | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Omit to leave the stored value unchanged. | false | +| `Key` | `*string` | :heavy_minus_sign: | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | +| `Name` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file diff --git a/docs/models/components/updatebyokkeyresponse.mdx b/docs/models/components/updatebyokkeyresponse.mdx index 55e120c86..6b4146dcd 100644 --- a/docs/models/components/updatebyokkeyresponse.mdx +++ b/docs/models/components/updatebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/updateenduserrequest.mdx b/docs/models/components/updateenduserrequest.mdx index ec9d18e3f..d17764d8f 100644 --- a/docs/models/components/updateenduserrequest.mdx +++ b/docs/models/components/updateenduserrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateEndUserRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `IsActive` | `bool` | ✅ | Registration state only; does not enforce inference access. | true | \ No newline at end of file +| `IsActive` | `bool` | :heavy_check_mark: | Registration state only; does not enforce inference access. | true | \ No newline at end of file diff --git a/docs/models/components/updateguardrailrequest.mdx b/docs/models/components/updateguardrailrequest.mdx index f9f4c8fca..33bedfd9d 100644 --- a/docs/models/components/updateguardrailrequest.mdx +++ b/docs/models/components/updateguardrailrequest.mdx @@ -6,24 +6,24 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput.mdx)] | ➖ | Builtin content filters to apply. Set to null to remove. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | -| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | ➖ | Custom regex content filters to apply. Set to null to remove. | null | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | New description for the guardrail | Updated description | -| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | -| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | -| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | -| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Omit to leave unchanged. | true | -| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | ➖ | New spending limit in USD | 75 | -| `Name` | `*string` | ➖ | New name for the guardrail | Updated Guardrail Name | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file +| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | +| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput.mdx)] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | +| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New description for the guardrail | Updated description | +| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | +| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | +| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | +| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | +| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | +| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | +| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | true | +| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | +| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | +| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Omit to leave unchanged. | true | +| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | New spending limit in USD | 75 | +| `Name` | `*string` | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/docs/models/components/updateguardrailresponse.mdx b/docs/models/components/updateguardrailresponse.mdx index 1bb5f6c1d..1e5506c82 100644 --- a/docs/models/components/updateguardrailresponse.mdx +++ b/docs/models/components/updateguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/components/updateinternrequest.mdx b/docs/models/components/updateinternrequest.mdx index 6e6fbaad8..d8a2a4bbc 100644 --- a/docs/models/components/updateinternrequest.mdx +++ b/docs/models/components/updateinternrequest.mdx @@ -9,7 +9,7 @@ Lifecycle settings to change. Omitted fields stay unchanged and null clears a fi | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | New free-form description. Null clears it. | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | ➖ | New standing instructions. Null clears them. | -| `Model` | optionalnullable.OptionalNullable[`string`] | ➖ | New OpenRouter model slug in `author/slug` form (an optional `:variant` suffix is accepted). Other shapes are refused with 400. Null restores the workspace default. Takes effect on the next provision: until then `GET` shows this configured model while chat chunks show the model the running intern reports. | -| `Name` | `*string` | ➖ | New intern name, unique per creator within the workspace. | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New free-form description. Null clears it. | +| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New standing instructions. Null clears them. | +| `Model` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New OpenRouter model slug in `author/slug` form (an optional `:variant` suffix is accepted). Other shapes are refused with 400. Null restores the workspace default. Takes effect on the next provision: until then `GET` shows this configured model while chat chunks show the model the running intern reports. | +| `Name` | `*string` | :heavy_minus_sign: | New intern name, unique per creator within the workspace. | \ No newline at end of file diff --git a/docs/models/components/updateobservabilitydestinationrequest.mdx b/docs/models/components/updateobservabilitydestinationrequest.mdx index b2fd6ca24..267a2bfbc 100644 --- a/docs/models/components/updateobservabilitydestinationrequest.mdx +++ b/docs/models/components/updateobservabilitydestinationrequest.mdx @@ -6,14 +6,14 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided. | null | -| `BroadcastGenerationCost` | `*bool` | ➖ | Whether to include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `*bool` | ➖ | Whether to include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `*bool` | ➖ | Whether to include request-context generation metadata. | false | -| `Config` | map[string]`any` | ➖ | Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | -| `Enabled` | `*bool` | ➖ | Whether the destination is enabled. | true | -| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | ➖ | N/A | null | -| `Name` | `*string` | ➖ | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `*bool` | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegionInput](../../models/components/observabilitydataregioninput.mdx) | ➖ | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field keeps the current value; it cannot be cleared. | [
"global"
] | -| `SamplingRate` | `*float64` | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file +| `APIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided. | null | +| `BroadcastGenerationCost` | `*bool` | :heavy_minus_sign: | Whether to include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `*bool` | :heavy_minus_sign: | Whether to include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `*bool` | :heavy_minus_sign: | Whether to include request-context generation metadata. | false | +| `Config` | map[string]`any` | :heavy_minus_sign: | Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | +| `Enabled` | `*bool` | :heavy_minus_sign: | Whether the destination is enabled. | true | +| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | :heavy_minus_sign: | N/A | null | +| `Name` | `*string` | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `*bool` | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegionInput](../../models/components/observabilitydataregioninput.mdx) | :heavy_minus_sign: | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field keeps the current value; it cannot be cleared. | [
"global"
] | +| `SamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/docs/models/components/updateobservabilitydestinationresponse.mdx b/docs/models/components/updateobservabilitydestinationresponse.mdx index 1e68bd976..80eae0f51 100644 --- a/docs/models/components/updateobservabilitydestinationresponse.mdx +++ b/docs/models/components/updateobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/updateorganizationsettingsrequest.mdx b/docs/models/components/updateorganizationsettingsrequest.mdx index 528d8636e..235c01e6f 100644 --- a/docs/models/components/updateorganizationsettingsrequest.mdx +++ b/docs/models/components/updateorganizationsettingsrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateOrganizationSettingsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IsFilteredModelCatalogEnabled` | `bool` | ✅ | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file +| `IsFilteredModelCatalogEnabled` | `bool` | :heavy_check_mark: | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file diff --git a/docs/models/components/updateprivateendpointpricingrequest.mdx b/docs/models/components/updateprivateendpointpricingrequest.mdx index b4af5b3b9..ddbf18c21 100644 --- a/docs/models/components/updateprivateendpointpricingrequest.mdx +++ b/docs/models/components/updateprivateendpointpricingrequest.mdx @@ -6,4 +6,4 @@ title: "UpdatePrivateEndpointPricingRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Pricing` | [components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | \ No newline at end of file +| `Pricing` | [components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | \ No newline at end of file diff --git a/docs/models/components/updateprivateendpointrequest.mdx b/docs/models/components/updateprivateendpointrequest.mdx index d19095dac..3587892f3 100644 --- a/docs/models/components/updateprivateendpointrequest.mdx +++ b/docs/models/components/updateprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "UpdatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BaseURL` | `*string` | ➖ | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.UpdatePrivateEndpointRequestDeclaredRegion](../../models/components/updateprivateendpointrequestdeclaredregion.mdx)] | ➖ | Attest where this deployment processes data. | us | -| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Attest that this deployment retains no prompt or completion data. | | -| `UpstreamModelID` | `string` | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `BaseURL` | `*string` | :heavy_minus_sign: | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.UpdatePrivateEndpointRequestDeclaredRegion](../../models/components/updateprivateendpointrequestdeclaredregion.mdx)] | :heavy_minus_sign: | Attest where this deployment processes data. | us | +| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | +| `UpstreamModelID` | `string` | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/components/updatescimgroupmappingrequest.mdx b/docs/models/components/updatescimgroupmappingrequest.mdx index 7f73f3770..6f1bbda29 100644 --- a/docs/models/components/updatescimgroupmappingrequest.mdx +++ b/docs/models/components/updatescimgroupmappingrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Role` | [components.UpdateScimGroupMappingRequestRole](../../models/components/updatescimgroupmappingrequestrole.mdx) | ✅ | N/A | \ No newline at end of file +| `Role` | [components.UpdateScimGroupMappingRequestRole](../../models/components/updatescimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/updatescimgroupmappingresponse.mdx b/docs/models/components/updatescimgroupmappingresponse.mdx index 7a421ef20..4e3c83a0d 100644 --- a/docs/models/components/updatescimgroupmappingresponse.mdx +++ b/docs/models/components/updatescimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/updateworkspacerequest.mdx b/docs/models/components/updateworkspacerequest.mdx index 071e304b5..0390b6896 100644 --- a/docs/models/components/updateworkspacerequest.mdx +++ b/docs/models/components/updateworkspacerequest.mdx @@ -6,15 +6,15 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Default text model for this workspace | openai/gpt-4o | -| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | New description for the workspace | Updated description | -| `DisabledServerTools` | optionalnullable.OptionalNullable[[][components.UpdateWorkspaceRequestDisabledServerTool](../../models/components/updateworkspacerequestdisabledservertool.mdx)] | ➖ | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | -| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | ➖ | Optional array of API key IDs to filter I/O logging | null | -| `IoLoggingSamplingRate` | `*float64` | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | -| `IsDataDiscountLoggingEnabled` | `*bool` | ➖ | Whether data discount logging is enabled | true | -| `IsObservabilityBroadcastEnabled` | `*bool` | ➖ | Whether broadcast is enabled | false | -| `IsObservabilityIoLoggingEnabled` | `*bool` | ➖ | Whether private logging is enabled | false | -| `Name` | `*string` | ➖ | New name for the workspace | Updated Workspace | -| `Slug` | `*string` | ➖ | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file +| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | +| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | +| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | +| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New description for the workspace | Updated description | +| `DisabledServerTools` | optionalnullable.OptionalNullable[[][components.UpdateWorkspaceRequestDisabledServerTool](../../models/components/updateworkspacerequestdisabledservertool.mdx)] | :heavy_minus_sign: | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | +| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | +| `IoLoggingSamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | +| `IsDataDiscountLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether data discount logging is enabled | true | +| `IsObservabilityBroadcastEnabled` | `*bool` | :heavy_minus_sign: | Whether broadcast is enabled | false | +| `IsObservabilityIoLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether private logging is enabled | false | +| `Name` | `*string` | :heavy_minus_sign: | New name for the workspace | Updated Workspace | +| `Slug` | `*string` | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file diff --git a/docs/models/components/updateworkspaceresponse.mdx b/docs/models/components/updateworkspaceresponse.mdx index b62589512..ff023e764 100644 --- a/docs/models/components/updateworkspaceresponse.mdx +++ b/docs/models/components/updateworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `Data` | [components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/components/upscalefactor.mdx b/docs/models/components/upscalefactor.mdx index 6296326aa..232a32a5c 100644 --- a/docs/models/components/upscalefactor.mdx +++ b/docs/models/components/upscalefactor.mdx @@ -9,5 +9,5 @@ Supported upscale factor range for video upscaling models | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `Max` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | -| `Min` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | \ No newline at end of file +| `Max` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | +| `Min` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/upsertworkspacebudgetrequest.mdx b/docs/models/components/upsertworkspacebudgetrequest.mdx index 677365333..738cc0513 100644 --- a/docs/models/components/upsertworkspacebudgetrequest.mdx +++ b/docs/models/components/upsertworkspacebudgetrequest.mdx @@ -6,5 +6,5 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether to include BYOK (bring-your-own-key) spend when enforcing the workspace's budgets. This is a workspace-wide setting: it applies to every budget interval (daily, weekly, monthly, and lifetime), not just the interval being upserted in this request. Omit to leave the current setting unchanged. | true | -| `LimitUsd` | `float64` | ✅ | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file +| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether to include BYOK (bring-your-own-key) spend when enforcing the workspace's budgets. This is a workspace-wide setting: it applies to every budget interval (daily, weekly, monthly, and lifetime), not just the interval being upserted in this request. Omit to leave the current setting unchanged. | true | +| `LimitUsd` | `float64` | :heavy_check_mark: | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file diff --git a/docs/models/components/upsertworkspacebudgetresponse.mdx b/docs/models/components/upsertworkspacebudgetresponse.mdx index de07de611..7535dc67f 100644 --- a/docs/models/components/upsertworkspacebudgetresponse.mdx +++ b/docs/models/components/upsertworkspacebudgetresponse.mdx @@ -6,5 +6,5 @@ title: "UpsertWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file +| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file diff --git a/docs/models/components/upstream.mdx b/docs/models/components/upstream.mdx index a4edeaacb..ee7daa48f 100644 --- a/docs/models/components/upstream.mdx +++ b/docs/models/components/upstream.mdx @@ -9,5 +9,5 @@ The upstream batch deletion outcome; omitted when no provider was assigned. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Provider` | `string` | ✅ | The provider name stored on the batch. | OpenAI | -| `Status` | [components.BatchDeletionOutcome](../../models/components/batchdeletionoutcome.mdx) | ✅ | Outcome for one deletion target: `deleted` (removed), `unsupported` (the provider has no batch-delete API; supported file cleanup still runs), or `not_applicable` (the batch never reached that target). | deleted | \ No newline at end of file +| `Provider` | `string` | :heavy_check_mark: | The provider name stored on the batch. | OpenAI | +| `Status` | [components.BatchDeletionOutcome](../../models/components/batchdeletionoutcome.mdx) | :heavy_check_mark: | Outcome for one deletion target: `deleted` (removed), `unsupported` (the provider has no batch-delete API; supported file cleanup still runs), or `not_applicable` (the batch never reached that target). | deleted | \ No newline at end of file diff --git a/docs/models/components/urlcitation.mdx b/docs/models/components/urlcitation.mdx index 6b4196055..6ed77177b 100644 --- a/docs/models/components/urlcitation.mdx +++ b/docs/models/components/urlcitation.mdx @@ -6,9 +6,9 @@ title: "URLCitation" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Content` | `*string` | ➖ | N/A | -| `EndIndex` | `int64` | ✅ | N/A | -| `StartIndex` | `int64` | ✅ | N/A | -| `Title` | `string` | ✅ | N/A | -| `Type` | [components.URLCitationType](../../models/components/urlcitationtype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Content` | `*string` | :heavy_minus_sign: | N/A | +| `EndIndex` | `int64` | :heavy_check_mark: | N/A | +| `StartIndex` | `int64` | :heavy_check_mark: | N/A | +| `Title` | `string` | :heavy_check_mark: | N/A | +| `Type` | [components.URLCitationType](../../models/components/urlcitationtype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/usage.mdx b/docs/models/components/usage.mdx index bd8ad7e2c..6b5bef783 100644 --- a/docs/models/components/usage.mdx +++ b/docs/models/components/usage.mdx @@ -6,12 +6,12 @@ title: "Usage" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `InputTokens` | `int64` | ✅ | N/A | | -| `InputTokensDetails` | [components.InputTokensDetails](../../models/components/inputtokensdetails.mdx) | ✅ | N/A | | -| `OutputTokens` | `int64` | ✅ | N/A | | -| `OutputTokensDetails` | [components.OutputTokensDetails](../../models/components/outputtokensdetails.mdx) | ✅ | N/A | | -| `TotalTokens` | `int64` | ✅ | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | -| `CostDetails` | [*components.UsageCostDetails](../../models/components/usagecostdetails.mdx) | ➖ | N/A | | -| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | \ No newline at end of file +| `InputTokens` | `int64` | :heavy_check_mark: | N/A | | +| `InputTokensDetails` | [components.InputTokensDetails](../../models/components/inputtokensdetails.mdx) | :heavy_check_mark: | N/A | | +| `OutputTokens` | `int64` | :heavy_check_mark: | N/A | | +| `OutputTokensDetails` | [components.OutputTokensDetails](../../models/components/outputtokensdetails.mdx) | :heavy_check_mark: | N/A | | +| `TotalTokens` | `int64` | :heavy_check_mark: | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | +| `CostDetails` | [*components.UsageCostDetails](../../models/components/usagecostdetails.mdx) | :heavy_minus_sign: | N/A | | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | \ No newline at end of file diff --git a/docs/models/components/usagecostdetails.mdx b/docs/models/components/usagecostdetails.mdx index 24886368e..c4fbf92e2 100644 --- a/docs/models/components/usagecostdetails.mdx +++ b/docs/models/components/usagecostdetails.mdx @@ -6,7 +6,7 @@ title: "UsageCostDetails" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ServerToolCost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | -| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | -| `UpstreamInferenceInputCost` | `float64` | ✅ | N/A | -| `UpstreamInferenceOutputCost` | `float64` | ✅ | N/A | \ No newline at end of file +| `ServerToolCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | +| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | +| `UpstreamInferenceInputCost` | `float64` | :heavy_check_mark: | N/A | +| `UpstreamInferenceOutputCost` | `float64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/userlocation.mdx b/docs/models/components/userlocation.mdx index 8152813e2..d066e2eb6 100644 --- a/docs/models/components/userlocation.mdx +++ b/docs/models/components/userlocation.mdx @@ -9,8 +9,8 @@ Approximate user location for location-biased search results. Passed through to | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [components.WebSearchPluginType](../../models/components/websearchplugintype.mdx) | ✅ | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [components.WebSearchPluginType](../../models/components/websearchplugintype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/validateprivateendpointrequest.mdx b/docs/models/components/validateprivateendpointrequest.mdx index af9fecb14..b83277f6d 100644 --- a/docs/models/components/validateprivateendpointrequest.mdx +++ b/docs/models/components/validateprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "ValidatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `WorkspaceID` | `string` | ✅ | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `WorkspaceID` | `string` | :heavy_check_mark: | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/vaulteffectivesecret.mdx b/docs/models/components/vaulteffectivesecret.mdx index acb7483ec..626d95cc7 100644 --- a/docs/models/components/vaulteffectivesecret.mdx +++ b/docs/models/components/vaulteffectivesecret.mdx @@ -9,8 +9,8 @@ Metadata for the one secret the intern's outbound requests receive under this na | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | N/A | -| `Fingerprint` | `*string` | ✅ | N/A | -| `Hosts` | []`string` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | -| `Scope` | [components.VaultEffectiveSecretScope](../../models/components/vaulteffectivesecretscope.mdx) | ✅ | Where the delivered secret is stored: `intern` for the intern's own vault, `attached` for a vault attached to the intern, `workspace` for the workspace vault. | \ No newline at end of file +| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | +| `Fingerprint` | `*string` | :heavy_check_mark: | N/A | +| `Hosts` | []`string` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | +| `Scope` | [components.VaultEffectiveSecretScope](../../models/components/vaulteffectivesecretscope.mdx) | :heavy_check_mark: | Where the delivered secret is stored: `intern` for the intern's own vault, `attached` for a vault attached to the intern, `workspace` for the workspace vault. | \ No newline at end of file diff --git a/docs/models/components/vaulteffectivesecretlistresponse.mdx b/docs/models/components/vaulteffectivesecretlistresponse.mdx index e0bc39729..40ecb5981 100644 --- a/docs/models/components/vaulteffectivesecretlistresponse.mdx +++ b/docs/models/components/vaulteffectivesecretlistresponse.mdx @@ -9,5 +9,5 @@ One page of the secrets an intern receives, one entry per name. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.VaultEffectiveSecret](../../models/components/vaulteffectivesecret.mdx) | ✅ | N/A | -| `HasMore` | `bool` | ✅ | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file +| `Data` | [][components.VaultEffectiveSecret](../../models/components/vaulteffectivesecret.mdx) | :heavy_check_mark: | N/A | +| `HasMore` | `bool` | :heavy_check_mark: | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file diff --git a/docs/models/components/vaultsecret.mdx b/docs/models/components/vaultsecret.mdx index b374b4c22..67332abd2 100644 --- a/docs/models/components/vaultsecret.mdx +++ b/docs/models/components/vaultsecret.mdx @@ -9,7 +9,7 @@ Metadata for one stored secret. The secret value is never returned. `fingerprint | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | N/A | -| `Fingerprint` | `*string` | ✅ | N/A | -| `Hosts` | []`string` | ✅ | N/A | -| `Name` | `string` | ✅ | N/A | \ No newline at end of file +| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | +| `Fingerprint` | `*string` | :heavy_check_mark: | N/A | +| `Hosts` | []`string` | :heavy_check_mark: | N/A | +| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/vaultsecretcopyrequest.mdx b/docs/models/components/vaultsecretcopyrequest.mdx index 4b2e18e2a..9238ec19c 100644 --- a/docs/models/components/vaultsecretcopyrequest.mdx +++ b/docs/models/components/vaultsecretcopyrequest.mdx @@ -9,4 +9,4 @@ Workspace secrets to copy into the intern scope. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Names` | []`string` | ✅ | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | \ No newline at end of file +| `Names` | []`string` | :heavy_check_mark: | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | \ No newline at end of file diff --git a/docs/models/components/vaultsecretcopyresponse.mdx b/docs/models/components/vaultsecretcopyresponse.mdx index 2b8f85062..947fe3fd6 100644 --- a/docs/models/components/vaultsecretcopyresponse.mdx +++ b/docs/models/components/vaultsecretcopyresponse.mdx @@ -9,4 +9,4 @@ Metadata for the copies now stored in the intern scope, one entry per requested | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Data` | [][components.VaultSecret](../../models/components/vaultsecret.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.VaultSecret](../../models/components/vaultsecret.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/vaultsecretlistresponse.mdx b/docs/models/components/vaultsecretlistresponse.mdx index e954a6222..eafe5927f 100644 --- a/docs/models/components/vaultsecretlistresponse.mdx +++ b/docs/models/components/vaultsecretlistresponse.mdx @@ -9,5 +9,5 @@ One page of secret metadata for the selected scope. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.VaultSecret](../../models/components/vaultsecret.mdx) | ✅ | N/A | -| `HasMore` | `bool` | ✅ | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file +| `Data` | [][components.VaultSecret](../../models/components/vaultsecret.mdx) | :heavy_check_mark: | N/A | +| `HasMore` | `bool` | :heavy_check_mark: | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file diff --git a/docs/models/components/vaultsecretresponse.mdx b/docs/models/components/vaultsecretresponse.mdx index 3bb2f25ce..6517479a2 100644 --- a/docs/models/components/vaultsecretresponse.mdx +++ b/docs/models/components/vaultsecretresponse.mdx @@ -9,4 +9,4 @@ Metadata for the stored secret. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.VaultSecret](../../models/components/vaultsecret.mdx) | ✅ | Metadata for one stored secret. The secret value is never returned. `fingerprint` is an HMAC-SHA-256 of the value keyed with that vault's own data key, so it is comparable only within one vault: equal fingerprints in one vault mean equal values, and rewriting the same value keeps its fingerprint. The same value stored in two vaults (for example a workspace secret and its intern copy) carries different fingerprints, so comparing fingerprints across vaults cannot show that a copy matches or that a rotation propagated. `hosts` and `fingerprint` are `null` only for legacy rows written before host binding was required; storing the secret again assigns hosts. | \{
"created_at": "2026-09-15T17:44:00.000Z",
"fingerprint": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"hosts": [
"api.github.com"
],
"name": "github_token"
} | \ No newline at end of file +| `Data` | [components.VaultSecret](../../models/components/vaultsecret.mdx) | :heavy_check_mark: | Metadata for one stored secret. The secret value is never returned. `fingerprint` is an HMAC-SHA-256 of the value keyed with that vault's own data key, so it is comparable only within one vault: equal fingerprints in one vault mean equal values, and rewriting the same value keeps its fingerprint. The same value stored in two vaults (for example a workspace secret and its intern copy) carries different fingerprints, so comparing fingerprints across vaults cannot show that a copy matches or that a rotation propagated. `hosts` and `fingerprint` are `null` only for legacy rows written before host binding was required; storing the secret again assigns hosts. | \{
"created_at": "2026-09-15T17:44:00.000Z",
"fingerprint": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"hosts": [
"api.github.com"
],
"name": "github_token"
} | \ No newline at end of file diff --git a/docs/models/components/vaultsecretwriterequest.mdx b/docs/models/components/vaultsecretwriterequest.mdx index 14e6c598b..4e4f5b956 100644 --- a/docs/models/components/vaultsecretwriterequest.mdx +++ b/docs/models/components/vaultsecretwriterequest.mdx @@ -9,5 +9,5 @@ Secret value and the exact hostnames it may be released to. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Hosts` | []`string` | ✅ | Exact DNS hostnames the secret may be sent to, 1 to 100 entries. Each entry is lowercased and a trailing dot is removed, so `API.Example.com.` is stored as `api.example.com`. Schemes, ports, paths, wildcards and empty values are rejected. Duplicates after normalization are collapsed. Matching is exact: a secret bound to `api.example.com` is never released to `example.com` or any other hostname. | -| `Value` | `string` | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file +| `Hosts` | []`string` | :heavy_check_mark: | Exact DNS hostnames the secret may be sent to, 1 to 100 entries. Each entry is lowercased and a trailing dot is removed, so `API.Example.com.` is stored as `api.example.com`. Schemes, ports, paths, wildcards and empty values are rejected. Duplicates after normalization are collapsed. Matching is exact: a secret bound to `api.example.com` is never released to `example.com` or any other hostname. | +| `Value` | `string` | :heavy_check_mark: | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file diff --git a/docs/models/components/videogeneration.mdx b/docs/models/components/videogeneration.mdx index 54ab7c7e4..591742048 100644 --- a/docs/models/components/videogeneration.mdx +++ b/docs/models/components/videogeneration.mdx @@ -6,6 +6,6 @@ title: "VideoGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/videogenerationrequest.mdx b/docs/models/components/videogenerationrequest.mdx index c9e768294..a996eaa67 100644 --- a/docs/models/components/videogenerationrequest.mdx +++ b/docs/models/components/videogenerationrequest.mdx @@ -6,21 +6,21 @@ title: "VideoGenerationRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AspectRatio` | [*components.VideoGenerationRequestAspectRatio](../../models/components/videogenerationrequestaspectratio.mdx) | ➖ | Aspect ratio of the generated video | 16:9 | -| `CallbackURL` | `*string` | ➖ | URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS. | https://example.com/webhook | -| `Creativity` | `*int64` | ➖ | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | -| `Duration` | `*int64` | ➖ | Duration of the generated video in seconds | 8 | -| `FrameImages` | [][components.FrameImage](../../models/components/frameimage.mdx) | ➖ | Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame. | | -| `GenerateAudio` | `*bool` | ➖ | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | -| `InputReferences` | [][components.InputReference](../../models/components/inputreference.mdx) | ➖ | Reference assets to guide video generation. Accepts image, audio, and video references. Audio and video references are only honored by providers that support them (including BytePlus Seedance generation 2 and newer); other providers use image references and ignore the rest. | | -| `Model` | `string` | ✅ | N/A | | -| `PreviousJobID` | `*string` | ➖ | ID of a completed video job to edit or extend, as returned by the submit response. The new job runs on the same model and endpoint that produced the previous one. Only models that support continuation accept this field. | gen-vid-1789493115-a1B2c3D4e5F6g7H8i9J0 | -| `Prompt` | `*string` | ➖ | Text prompt describing the video to generate. Optional for models that support generating a video from image input alone; required by all other models. | A serene mountain landscape at sunset | -| `Provider` | [*components.VideoGenerationRequestProvider](../../models/components/videogenerationrequestprovider.mdx) | ➖ | Provider-specific passthrough configuration | | -| `Resolution` | [*components.VideoGenerationRequestResolution](../../models/components/videogenerationrequestresolution.mdx) | ➖ | Resolution of the generated video | 720p | -| `Seed` | `*int64` | ➖ | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Size` | `*string` | ➖ | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `UpscaleFactor` | `*float64` | ➖ | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | -| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `AspectRatio` | [*components.VideoGenerationRequestAspectRatio](../../models/components/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | +| `CallbackURL` | `*string` | :heavy_minus_sign: | URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS. | https://example.com/webhook | +| `Creativity` | `*int64` | :heavy_minus_sign: | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | +| `Duration` | `*int64` | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | +| `FrameImages` | [][components.FrameImage](../../models/components/frameimage.mdx) | :heavy_minus_sign: | Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame. | | +| `GenerateAudio` | `*bool` | :heavy_minus_sign: | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | +| `InputReferences` | [][components.InputReference](../../models/components/inputreference.mdx) | :heavy_minus_sign: | Reference assets to guide video generation. Accepts image, audio, and video references. Audio and video references are only honored by providers that support them (including BytePlus Seedance generation 2 and newer); other providers use image references and ignore the rest. | | +| `Model` | `string` | :heavy_check_mark: | N/A | | +| `PreviousJobID` | `*string` | :heavy_minus_sign: | ID of a completed video job to edit or extend, as returned by the submit response. The new job runs on the same model and endpoint that produced the previous one. Only models that support continuation accept this field. | gen-vid-1789493115-a1B2c3D4e5F6g7H8i9J0 | +| `Prompt` | `*string` | :heavy_minus_sign: | Text prompt describing the video to generate. Optional for models that support generating a video from image input alone; required by all other models. | A serene mountain landscape at sunset | +| `Provider` | [*components.VideoGenerationRequestProvider](../../models/components/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `Resolution` | [*components.VideoGenerationRequestResolution](../../models/components/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | +| `Seed` | `*int64` | :heavy_minus_sign: | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Size` | `*string` | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `UpscaleFactor` | `*float64` | :heavy_minus_sign: | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | +| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/components/videogenerationrequestoptions.mdx b/docs/models/components/videogenerationrequestoptions.mdx index 0976a4cef..a4dd8503e 100644 --- a/docs/models/components/videogenerationrequestoptions.mdx +++ b/docs/models/components/videogenerationrequestoptions.mdx @@ -9,149 +9,149 @@ Provider-specific options keyed by provider slug. Only options for the matched p | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Oneai` | map[string]`any` | ➖ | N/A | -| `Ai21` | map[string]`any` | ➖ | N/A | -| `AionLabs` | map[string]`any` | ➖ | N/A | -| `Akashml` | map[string]`any` | ➖ | N/A | -| `Alibaba` | map[string]`any` | ➖ | N/A | -| `AmazonBedrock` | map[string]`any` | ➖ | N/A | -| `AmazonBedrockClaudeOnAws` | map[string]`any` | ➖ | N/A | -| `AmazonNova` | map[string]`any` | ➖ | N/A | -| `Ambient` | map[string]`any` | ➖ | N/A | -| `Anthropic` | map[string]`any` | ➖ | N/A | -| `Anthropic2` | map[string]`any` | ➖ | N/A | -| `Anyscale` | map[string]`any` | ➖ | N/A | -| `ArceeAi` | map[string]`any` | ➖ | N/A | -| `Assemblyai` | map[string]`any` | ➖ | N/A | -| `AtlasCloud` | map[string]`any` | ➖ | N/A | -| `Atoma` | map[string]`any` | ➖ | N/A | -| `Avian` | map[string]`any` | ➖ | N/A | -| `Azure` | map[string]`any` | ➖ | N/A | -| `Baidu` | map[string]`any` | ➖ | N/A | -| `Baseten` | map[string]`any` | ➖ | N/A | -| `BlackForestLabs` | map[string]`any` | ➖ | N/A | -| `Byteplus` | map[string]`any` | ➖ | N/A | -| `Centml` | map[string]`any` | ➖ | N/A | -| `Cerebras` | map[string]`any` | ➖ | N/A | -| `Chutes` | map[string]`any` | ➖ | N/A | -| `Cirrascale` | map[string]`any` | ➖ | N/A | -| `Clarifai` | map[string]`any` | ➖ | N/A | -| `ClaudeOnAws` | map[string]`any` | ➖ | N/A | -| `Cloudflare` | map[string]`any` | ➖ | N/A | -| `Cohere` | map[string]`any` | ➖ | N/A | -| `Coreweave` | map[string]`any` | ➖ | N/A | -| `Cosine` | map[string]`any` | ➖ | N/A | -| `Crofai` | map[string]`any` | ➖ | N/A | -| `Crucible` | map[string]`any` | ➖ | N/A | -| `Crusoe` | map[string]`any` | ➖ | N/A | -| `Darkbloom` | map[string]`any` | ➖ | N/A | -| `Databricks` | map[string]`any` | ➖ | N/A | -| `Decart` | map[string]`any` | ➖ | N/A | -| `Deepgram` | map[string]`any` | ➖ | N/A | -| `Deepinfra` | map[string]`any` | ➖ | N/A | -| `Deepseek` | map[string]`any` | ➖ | N/A | -| `Dekallm` | map[string]`any` | ➖ | N/A | -| `Digitalocean` | map[string]`any` | ➖ | N/A | -| `Elevenlabs` | map[string]`any` | ➖ | N/A | -| `Enfer` | map[string]`any` | ➖ | N/A | -| `FakeProvider` | map[string]`any` | ➖ | N/A | -| `Featherless` | map[string]`any` | ➖ | N/A | -| `Fireworks` | map[string]`any` | ➖ | N/A | -| `FishAudio` | map[string]`any` | ➖ | N/A | -| `Friendli` | map[string]`any` | ➖ | N/A | -| `Gmicloud` | map[string]`any` | ➖ | N/A | -| `GoogleAiStudio` | map[string]`any` | ➖ | N/A | -| `GoogleVertex` | map[string]`any` | ➖ | N/A | -| `Gopomelo` | map[string]`any` | ➖ | N/A | -| `Groq` | map[string]`any` | ➖ | N/A | -| `Heygen` | map[string]`any` | ➖ | N/A | -| `Huggingface` | map[string]`any` | ➖ | N/A | -| `Hyperbolic` | map[string]`any` | ➖ | N/A | -| `HyperbolicQuantized` | map[string]`any` | ➖ | N/A | -| `Inception` | map[string]`any` | ➖ | N/A | -| `Inceptron` | map[string]`any` | ➖ | N/A | -| `InferactVllm` | map[string]`any` | ➖ | N/A | -| `InferenceNet` | map[string]`any` | ➖ | N/A | -| `Infermatic` | map[string]`any` | ➖ | N/A | -| `Inflection` | map[string]`any` | ➖ | N/A | -| `Inocloud` | map[string]`any` | ➖ | N/A | -| `IoNet` | map[string]`any` | ➖ | N/A | -| `Ionstream` | map[string]`any` | ➖ | N/A | -| `Klusterai` | map[string]`any` | ➖ | N/A | -| `Krea` | map[string]`any` | ➖ | N/A | -| `Lambda` | map[string]`any` | ➖ | N/A | -| `Lepton` | map[string]`any` | ➖ | N/A | -| `Liquid` | map[string]`any` | ➖ | N/A | -| `Lynn` | map[string]`any` | ➖ | N/A | -| `LynnPrivate` | map[string]`any` | ➖ | N/A | -| `Makora` | map[string]`any` | ➖ | N/A | -| `Mancer` | map[string]`any` | ➖ | N/A | -| `MancerOld` | map[string]`any` | ➖ | N/A | -| `Mara` | map[string]`any` | ➖ | N/A | -| `Meta` | map[string]`any` | ➖ | N/A | -| `Minimax` | map[string]`any` | ➖ | N/A | -| `Mistral` | map[string]`any` | ➖ | N/A | -| `Modal` | map[string]`any` | ➖ | N/A | -| `Modelrun` | map[string]`any` | ➖ | N/A | -| `Modular` | map[string]`any` | ➖ | N/A | -| `Moonshotai` | map[string]`any` | ➖ | N/A | -| `Morph` | map[string]`any` | ➖ | N/A | -| `Ncompass` | map[string]`any` | ➖ | N/A | -| `NearAi` | map[string]`any` | ➖ | N/A | -| `Nebius` | map[string]`any` | ➖ | N/A | -| `NexAgi` | map[string]`any` | ➖ | N/A | -| `Nextbit` | map[string]`any` | ➖ | N/A | -| `Nineteen` | map[string]`any` | ➖ | N/A | -| `Novita` | map[string]`any` | ➖ | N/A | -| `Nvidia` | map[string]`any` | ➖ | N/A | -| `Octoai` | map[string]`any` | ➖ | N/A | -| `Ollama` | map[string]`any` | ➖ | N/A | -| `OpenInference` | map[string]`any` | ➖ | N/A | -| `Openai` | map[string]`any` | ➖ | N/A | -| `Parasail` | map[string]`any` | ➖ | N/A | -| `Perceptron` | map[string]`any` | ➖ | N/A | -| `Perplexity` | map[string]`any` | ➖ | N/A | -| `Phala` | map[string]`any` | ➖ | N/A | -| `Poolside` | map[string]`any` | ➖ | N/A | -| `Primeintellect` | map[string]`any` | ➖ | N/A | -| `Quiver` | map[string]`any` | ➖ | N/A | -| `Recraft` | map[string]`any` | ➖ | N/A | -| `Recursal` | map[string]`any` | ➖ | N/A | -| `Reflection` | map[string]`any` | ➖ | N/A | -| `Reka` | map[string]`any` | ➖ | N/A | -| `Relace` | map[string]`any` | ➖ | N/A | -| `Replicate` | map[string]`any` | ➖ | N/A | -| `Respan` | map[string]`any` | ➖ | N/A | -| `Runway` | map[string]`any` | ➖ | N/A | -| `SailResearch` | map[string]`any` | ➖ | N/A | -| `Sakana` | map[string]`any` | ➖ | N/A | -| `SakanaAi` | map[string]`any` | ➖ | N/A | -| `Sambanova` | map[string]`any` | ➖ | N/A | -| `SambanovaCloaked` | map[string]`any` | ➖ | N/A | -| `Scaledown` | map[string]`any` | ➖ | N/A | -| `Seed` | map[string]`any` | ➖ | N/A | -| `SfCompute` | map[string]`any` | ➖ | N/A | -| `Siliconflow` | map[string]`any` | ➖ | N/A | -| `Sourceful` | map[string]`any` | ➖ | N/A | -| `Stealth` | map[string]`any` | ➖ | N/A | -| `Stepfun` | map[string]`any` | ➖ | N/A | -| `Streamlake` | map[string]`any` | ➖ | N/A | -| `Switchpoint` | map[string]`any` | ➖ | N/A | -| `Targon` | map[string]`any` | ➖ | N/A | -| `Tencent` | map[string]`any` | ➖ | N/A | -| `Tenstorrent` | map[string]`any` | ➖ | N/A | -| `Thinkingmachines` | map[string]`any` | ➖ | N/A | -| `Together` | map[string]`any` | ➖ | N/A | -| `TogetherLite` | map[string]`any` | ➖ | N/A | -| `Typesafe` | map[string]`any` | ➖ | N/A | -| `Ubicloud` | map[string]`any` | ➖ | N/A | -| `Unbiased` | map[string]`any` | ➖ | N/A | -| `Upstage` | map[string]`any` | ➖ | N/A | -| `Venice` | map[string]`any` | ➖ | N/A | -| `Voyageai` | map[string]`any` | ➖ | N/A | -| `Wafer` | map[string]`any` | ➖ | N/A | -| `Wandb` | map[string]`any` | ➖ | N/A | -| `WandbLegacy` | map[string]`any` | ➖ | N/A | -| `Xai` | map[string]`any` | ➖ | N/A | -| `Xiaomi` | map[string]`any` | ➖ | N/A | -| `ZAi` | map[string]`any` | ➖ | N/A | \ No newline at end of file +| `Oneai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ai21` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AionLabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Akashml` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Alibaba` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonBedrock` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonBedrockClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AmazonNova` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ambient` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anthropic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anthropic2` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Anyscale` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ArceeAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Assemblyai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `AtlasCloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Atoma` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Avian` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Azure` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Baidu` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Baseten` | map[string]`any` | :heavy_minus_sign: | N/A | +| `BlackForestLabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Byteplus` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Centml` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cerebras` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Chutes` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cirrascale` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Clarifai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cloudflare` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cohere` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Coreweave` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Cosine` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crofai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crucible` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Crusoe` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Darkbloom` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Databricks` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Decart` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepgram` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepinfra` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Deepseek` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Dekallm` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Digitalocean` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Elevenlabs` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Enfer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `FakeProvider` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Featherless` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Fireworks` | map[string]`any` | :heavy_minus_sign: | N/A | +| `FishAudio` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Friendli` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Gmicloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `GoogleAiStudio` | map[string]`any` | :heavy_minus_sign: | N/A | +| `GoogleVertex` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Gopomelo` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Groq` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Heygen` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Huggingface` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Hyperbolic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `HyperbolicQuantized` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inception` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inceptron` | map[string]`any` | :heavy_minus_sign: | N/A | +| `InferactVllm` | map[string]`any` | :heavy_minus_sign: | N/A | +| `InferenceNet` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Infermatic` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inflection` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Inocloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `IoNet` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ionstream` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Klusterai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Krea` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lambda` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lepton` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Liquid` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Lynn` | map[string]`any` | :heavy_minus_sign: | N/A | +| `LynnPrivate` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Makora` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mancer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `MancerOld` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mara` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Meta` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Minimax` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Mistral` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modal` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modelrun` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Modular` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Moonshotai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Morph` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ncompass` | map[string]`any` | :heavy_minus_sign: | N/A | +| `NearAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nebius` | map[string]`any` | :heavy_minus_sign: | N/A | +| `NexAgi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nextbit` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nineteen` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Novita` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Nvidia` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Octoai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ollama` | map[string]`any` | :heavy_minus_sign: | N/A | +| `OpenInference` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Openai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Parasail` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Perceptron` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Perplexity` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Phala` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Poolside` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Primeintellect` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Quiver` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Recraft` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Recursal` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Reflection` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Reka` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Relace` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Replicate` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Respan` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Runway` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SailResearch` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sakana` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SakanaAi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sambanova` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SambanovaCloaked` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Scaledown` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Seed` | map[string]`any` | :heavy_minus_sign: | N/A | +| `SfCompute` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Siliconflow` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Sourceful` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Stealth` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Stepfun` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Streamlake` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Switchpoint` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Targon` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Tencent` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Tenstorrent` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Thinkingmachines` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Together` | map[string]`any` | :heavy_minus_sign: | N/A | +| `TogetherLite` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Typesafe` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Ubicloud` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Unbiased` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Upstage` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Venice` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Voyageai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Wafer` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Wandb` | map[string]`any` | :heavy_minus_sign: | N/A | +| `WandbLegacy` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Xai` | map[string]`any` | :heavy_minus_sign: | N/A | +| `Xiaomi` | map[string]`any` | :heavy_minus_sign: | N/A | +| `ZAi` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/videogenerationrequestprovider.mdx b/docs/models/components/videogenerationrequestprovider.mdx index 0ea53fd15..aab1e7556 100644 --- a/docs/models/components/videogenerationrequestprovider.mdx +++ b/docs/models/components/videogenerationrequestprovider.mdx @@ -9,4 +9,4 @@ Provider-specific passthrough configuration | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Options` | [*components.VideoGenerationRequestOptions](../../models/components/videogenerationrequestoptions.mdx) | ➖ | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file +| `Options` | [*components.VideoGenerationRequestOptions](../../models/components/videogenerationrequestoptions.mdx) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file diff --git a/docs/models/components/videogenerationresponse.mdx b/docs/models/components/videogenerationresponse.mdx index dc11d818c..00475f351 100644 --- a/docs/models/components/videogenerationresponse.mdx +++ b/docs/models/components/videogenerationresponse.mdx @@ -6,10 +6,10 @@ title: "VideoGenerationResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Error` | `*string` | ➖ | N/A | | -| `GenerationID` | `*string` | ➖ | The generation ID associated with this video generation job. Available once the job has been processed. | | -| `ID` | `string` | ✅ | The video job ID, in the `gen-vid--<20 alphanumerics>` generation ID format. Pass it as `previous_job_id` to continue the generation. | | -| `PollingURL` | `string` | ✅ | N/A | | -| `Status` | [components.VideoGenerationResponseStatus](../../models/components/videogenerationresponsestatus.mdx) | ✅ | N/A | | -| `UnsignedUrls` | []`string` | ➖ | N/A | | -| `Usage` | [*components.VideoGenerationUsage](../../models/components/videogenerationusage.mdx) | ➖ | Usage and cost information for the video generation. Available once the job has completed. | \{
"cost": 0.5,
"is_byok": false
} | \ No newline at end of file +| `Error` | `*string` | :heavy_minus_sign: | N/A | | +| `GenerationID` | `*string` | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | +| `ID` | `string` | :heavy_check_mark: | The video job ID, in the `gen-vid--<20 alphanumerics>` generation ID format. Pass it as `previous_job_id` to continue the generation. | | +| `PollingURL` | `string` | :heavy_check_mark: | N/A | | +| `Status` | [components.VideoGenerationResponseStatus](../../models/components/videogenerationresponsestatus.mdx) | :heavy_check_mark: | N/A | | +| `UnsignedUrls` | []`string` | :heavy_minus_sign: | N/A | | +| `Usage` | [*components.VideoGenerationUsage](../../models/components/videogenerationusage.mdx) | :heavy_minus_sign: | Usage and cost information for the video generation. Available once the job has completed. | \{
"cost": 0.5,
"is_byok": false
} | \ No newline at end of file diff --git a/docs/models/components/videogenerationusage.mdx b/docs/models/components/videogenerationusage.mdx index 8afc1d1af..3b380a8ac 100644 --- a/docs/models/components/videogenerationusage.mdx +++ b/docs/models/components/videogenerationusage.mdx @@ -9,5 +9,5 @@ Usage and cost information for the video generation. Available once the job has | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | The cost of the video generation in USD. | -| `IsBYOK` | `*bool` | ➖ | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file +| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | The cost of the video generation in USD. | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file diff --git a/docs/models/components/videomodel.mdx b/docs/models/components/videomodel.mdx index 4bf306d18..1015c9157 100644 --- a/docs/models/components/videomodel.mdx +++ b/docs/models/components/videomodel.mdx @@ -6,20 +6,20 @@ title: "VideoModel" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `AllowedPassthroughParameters` | []`string` | ✅ | List of parameters that are allowed to be passed through to the provider | | -| `CanonicalSlug` | `string` | ✅ | Canonical slug for the model | openai/gpt-4 | -| `Created` | `int64` | ✅ | Unix timestamp of when the model was created | 1692901234 | -| `Creativity` | []`int64` | ✅ | Supported creativity levels for video upscaling models | | -| `Description` | `*string` | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `GenerateAudio` | `*bool` | ✅ | Whether the model supports generating audio alongside video | | -| `HuggingFaceID` | optionalnullable.OptionalNullable[`string`] | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `ID` | `string` | ✅ | Unique identifier for the model | openai/gpt-4 | -| `Name` | `string` | ✅ | Display name of the model | GPT-4 | -| `PricingSkus` | optionalnullable.OptionalNullable[map[string]`string`] | ➖ | Pricing SKUs with provider prefix stripped, values as strings | | -| `Seed` | `*bool` | ✅ | Whether the model supports deterministic generation via seed parameter | | -| `SupportedAspectRatios` | [][components.SupportedAspectRatio](../../models/components/supportedaspectratio.mdx) | ✅ | Supported output aspect ratios | | -| `SupportedDurations` | []`int64` | ✅ | Supported video durations in seconds | | -| `SupportedFrameImages` | [][components.SupportedFrameImage](../../models/components/supportedframeimage.mdx) | ✅ | Supported frame image types (e.g. first_frame, last_frame) | | -| `SupportedResolutions` | [][components.SupportedResolution](../../models/components/supportedresolution.mdx) | ✅ | Supported output resolutions | | -| `SupportedSizes` | [][components.SupportedSize](../../models/components/supportedsize.mdx) | ✅ | Supported output sizes (width x height) | | -| `UpscaleFactor` | [*components.UpscaleFactor](../../models/components/upscalefactor.mdx) | ✅ | Supported upscale factor range for video upscaling models | | \ No newline at end of file +| `AllowedPassthroughParameters` | []`string` | :heavy_check_mark: | List of parameters that are allowed to be passed through to the provider | | +| `CanonicalSlug` | `string` | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | +| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | +| `Creativity` | []`int64` | :heavy_check_mark: | Supported creativity levels for video upscaling models | | +| `Description` | `*string` | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `GenerateAudio` | `*bool` | :heavy_check_mark: | Whether the model supports generating audio alongside video | | +| `HuggingFaceID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | +| `Name` | `string` | :heavy_check_mark: | Display name of the model | GPT-4 | +| `PricingSkus` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | +| `Seed` | `*bool` | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | +| `SupportedAspectRatios` | [][components.SupportedAspectRatio](../../models/components/supportedaspectratio.mdx) | :heavy_check_mark: | Supported output aspect ratios | | +| `SupportedDurations` | []`int64` | :heavy_check_mark: | Supported video durations in seconds | | +| `SupportedFrameImages` | [][components.SupportedFrameImage](../../models/components/supportedframeimage.mdx) | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | +| `SupportedResolutions` | [][components.SupportedResolution](../../models/components/supportedresolution.mdx) | :heavy_check_mark: | Supported output resolutions | | +| `SupportedSizes` | [][components.SupportedSize](../../models/components/supportedsize.mdx) | :heavy_check_mark: | Supported output sizes (width x height) | | +| `UpscaleFactor` | [*components.UpscaleFactor](../../models/components/upscalefactor.mdx) | :heavy_check_mark: | Supported upscale factor range for video upscaling models | | \ No newline at end of file diff --git a/docs/models/components/videomodelslistresponse.mdx b/docs/models/components/videomodelslistresponse.mdx index c42abae72..de05095d7 100644 --- a/docs/models/components/videomodelslistresponse.mdx +++ b/docs/models/components/videomodelslistresponse.mdx @@ -6,4 +6,4 @@ title: "VideoModelsListResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Data` | [][components.VideoModel](../../models/components/videomodel.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.VideoModel](../../models/components/videomodel.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/videourl.mdx b/docs/models/components/videourl.mdx index 727ca30ff..635d4df44 100644 --- a/docs/models/components/videourl.mdx +++ b/docs/models/components/videourl.mdx @@ -6,4 +6,4 @@ title: "VideoURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webfetchplugin.mdx b/docs/models/components/webfetchplugin.mdx index d15f84f02..da53f8690 100644 --- a/docs/models/components/webfetchplugin.mdx +++ b/docs/models/components/webfetchplugin.mdx @@ -6,8 +6,8 @@ title: "WebFetchPlugin" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | ➖ | Only fetch from these domains. | -| `BlockedDomains` | []`string` | ➖ | Never fetch from these domains. | -| `ID` | [components.WebFetchPluginID](../../models/components/webfetchpluginid.mdx) | ✅ | N/A | -| `MaxContentTokens` | `*int64` | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | -| `MaxUses` | `*int64` | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file +| `AllowedDomains` | []`string` | :heavy_minus_sign: | Only fetch from these domains. | +| `BlockedDomains` | []`string` | :heavy_minus_sign: | Never fetch from these domains. | +| `ID` | [components.WebFetchPluginID](../../models/components/webfetchpluginid.mdx) | :heavy_check_mark: | N/A | +| `MaxContentTokens` | `*int64` | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file diff --git a/docs/models/components/webfetchservertool.mdx b/docs/models/components/webfetchservertool.mdx index 4291be9d7..af9313472 100644 --- a/docs/models/components/webfetchservertool.mdx +++ b/docs/models/components/webfetchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: fetches full content from a URL (web page or PD | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.WebFetchServerToolConfig](../../models/components/webfetchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | -| `Type` | [components.WebFetchServerToolType](../../models/components/webfetchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebFetchServerToolConfig](../../models/components/webfetchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | +| `Type` | [components.WebFetchServerToolType](../../models/components/webfetchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/webfetchservertoolconfig.mdx b/docs/models/components/webfetchservertoolconfig.mdx index 07f84a177..34e1d4799 100644 --- a/docs/models/components/webfetchservertoolconfig.mdx +++ b/docs/models/components/webfetchservertoolconfig.mdx @@ -9,8 +9,8 @@ Configuration for the openrouter:web_fetch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | ➖ | Only fetch from these domains. | | -| `BlockedDomains` | []`string` | ➖ | Never fetch from these domains. | | -| `Engine` | [*components.WebFetchEngineEnum](../../models/components/webfetchengineenum.mdx) | ➖ | Which fetch engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in fetch. "exa" uses Exa Contents API. "openrouter" uses direct HTTP fetch. "firecrawl" uses Firecrawl scrape (requires BYOK). "parallel" uses the Parallel extract API. | auto | -| `MaxContentTokens` | `*int64` | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | -| `MaxUses` | `*int64` | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file +| `AllowedDomains` | []`string` | :heavy_minus_sign: | Only fetch from these domains. | | +| `BlockedDomains` | []`string` | :heavy_minus_sign: | Never fetch from these domains. | | +| `Engine` | [*components.WebFetchEngineEnum](../../models/components/webfetchengineenum.mdx) | :heavy_minus_sign: | Which fetch engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in fetch. "exa" uses Exa Contents API. "openrouter" uses direct HTTP fetch. "firecrawl" uses Firecrawl scrape (requires BYOK). "parallel" uses the Parallel extract API. | auto | +| `MaxContentTokens` | `*int64` | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file diff --git a/docs/models/components/websearchcallcompletedevent.mdx b/docs/models/components/websearchcallcompletedevent.mdx index 213ce0088..22397fcaa 100644 --- a/docs/models/components/websearchcallcompletedevent.mdx +++ b/docs/models/components/websearchcallcompletedevent.mdx @@ -9,7 +9,7 @@ Web search call completed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.WebSearchCallCompletedEventType](../../models/components/websearchcallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.WebSearchCallCompletedEventType](../../models/components/websearchcallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchcallinprogressevent.mdx b/docs/models/components/websearchcallinprogressevent.mdx index 5d165e16b..6a868ad82 100644 --- a/docs/models/components/websearchcallinprogressevent.mdx +++ b/docs/models/components/websearchcallinprogressevent.mdx @@ -9,7 +9,7 @@ Web search call in progress | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.WebSearchCallInProgressEventType](../../models/components/websearchcallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.WebSearchCallInProgressEventType](../../models/components/websearchcallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchcallsearchingevent.mdx b/docs/models/components/websearchcallsearchingevent.mdx index b25f8f8a9..7f16925af 100644 --- a/docs/models/components/websearchcallsearchingevent.mdx +++ b/docs/models/components/websearchcallsearchingevent.mdx @@ -9,7 +9,7 @@ Web search call is searching | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | ✅ | N/A | -| `OutputIndex` | `int64` | ✅ | N/A | -| `SequenceNumber` | `int64` | ✅ | N/A | -| `Type` | [components.WebSearchCallSearchingEventType](../../models/components/websearchcallsearchingeventtype.mdx) | ✅ | N/A | \ No newline at end of file +| `ItemID` | `string` | :heavy_check_mark: | N/A | +| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | +| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | +| `Type` | [components.WebSearchCallSearchingEventType](../../models/components/websearchcallsearchingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchcitation.mdx b/docs/models/components/websearchcitation.mdx index fb7e80324..314dcb0d8 100644 --- a/docs/models/components/websearchcitation.mdx +++ b/docs/models/components/websearchcitation.mdx @@ -6,7 +6,7 @@ title: "WebSearchCitation" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `CitedText` | `*string` | ➖ | N/A | -| `EncryptedIndex` | `*string` | ➖ | N/A | -| `Title` | `*string` | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `CitedText` | `*string` | :heavy_minus_sign: | N/A | +| `EncryptedIndex` | `*string` | :heavy_minus_sign: | N/A | +| `Title` | `*string` | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchconfig.mdx b/docs/models/components/websearchconfig.mdx index 90b6588d1..c7cbb1681 100644 --- a/docs/models/components/websearchconfig.mdx +++ b/docs/models/components/websearchconfig.mdx @@ -6,14 +6,14 @@ title: "WebSearchConfig" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `ExcludedDomains` | []`string` | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `MaxCharacters` | `*int64` | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxTotalResults` | `*int64` | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `MaxCharacters` | `*int64` | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxTotalResults` | `*int64` | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/websearchdomainfilter.mdx b/docs/models/components/websearchdomainfilter.mdx index a9eddd763..a680c4452 100644 --- a/docs/models/components/websearchdomainfilter.mdx +++ b/docs/models/components/websearchdomainfilter.mdx @@ -6,6 +6,6 @@ title: "WebSearchDomainFilter" | Field | Type | Required | Description | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | -| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | -| `ExcludedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | \ No newline at end of file +| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | +| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | +| `ExcludedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchplugin.mdx b/docs/models/components/websearchplugin.mdx index 2acce8575..fbf34f9d7 100644 --- a/docs/models/components/websearchplugin.mdx +++ b/docs/models/components/websearchplugin.mdx @@ -6,14 +6,14 @@ title: "WebSearchPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Enabled` | `*bool` | ➖ | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `Engine` | [*components.WebSearchEngine](../../models/components/websearchengine.mdx) | ➖ | The search engine to use for web search. | exa | -| `ExcludeDomains` | []`string` | ➖ | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | -| `ID` | [components.WebSearchPluginID](../../models/components/websearchpluginid.mdx) | ✅ | N/A | | -| `IncludeDomains` | []`string` | ➖ | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | -| `MaxResults` | `*int64` | ➖ | N/A | | -| `MaxUses` | `*int64` | ➖ | Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic). | | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchPrompt` | `*string` | ➖ | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.UserLocation](../../models/components/userlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | +| `Engine` | [*components.WebSearchEngine](../../models/components/websearchengine.mdx) | :heavy_minus_sign: | The search engine to use for web search. | exa | +| `ExcludeDomains` | []`string` | :heavy_minus_sign: | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | +| `ID` | [components.WebSearchPluginID](../../models/components/websearchpluginid.mdx) | :heavy_check_mark: | N/A | | +| `IncludeDomains` | []`string` | :heavy_minus_sign: | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | +| `MaxResults` | `*int64` | :heavy_minus_sign: | N/A | | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic). | | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchPrompt` | `*string` | :heavy_minus_sign: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.UserLocation](../../models/components/userlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/websearchservertool.mdx b/docs/models/components/websearchservertool.mdx index a465fa1b1..32f65540f 100644 --- a/docs/models/components/websearchservertool.mdx +++ b/docs/models/components/websearchservertool.mdx @@ -9,12 +9,12 @@ Web search tool configuration (2025-08-26 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | -| `Type` | [components.WebSearchServerToolType](../../models/components/websearchservertooltype.mdx) | ✅ | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `Type` | [components.WebSearchServerToolType](../../models/components/websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/websearchservertoolconfig.mdx b/docs/models/components/websearchservertoolconfig.mdx index 70cb4c164..940c89976 100644 --- a/docs/models/components/websearchservertoolconfig.mdx +++ b/docs/models/components/websearchservertoolconfig.mdx @@ -9,14 +9,14 @@ Configuration for the openrouter:web_search server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `ExcludedDomains` | []`string` | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `MaxCharacters` | `*int64` | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxTotalResults` | `*int64` | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `MaxCharacters` | `*int64` | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxTotalResults` | `*int64` | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/websearchservertoolopenrouter.mdx b/docs/models/components/websearchservertoolopenrouter.mdx index d31e85bb5..45b54e513 100644 --- a/docs/models/components/websearchservertoolopenrouter.mdx +++ b/docs/models/components/websearchservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.WebSearchServerToolConfig](../../models/components/websearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `Type` | [components.WebSearchServerToolOpenRouterType](../../models/components/websearchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebSearchServerToolConfig](../../models/components/websearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `Type` | [components.WebSearchServerToolOpenRouterType](../../models/components/websearchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/websearchsource.mdx b/docs/models/components/websearchsource.mdx index 3074f01a2..395f5a3ad 100644 --- a/docs/models/components/websearchsource.mdx +++ b/docs/models/components/websearchsource.mdx @@ -6,5 +6,5 @@ title: "WebSearchSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.WebSearchSourceType](../../models/components/websearchsourcetype.mdx) | ✅ | N/A | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `Type` | [components.WebSearchSourceType](../../models/components/websearchsourcetype.mdx) | :heavy_check_mark: | N/A | +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchuserlocation.mdx b/docs/models/components/websearchuserlocation.mdx index 81ec099b0..272b63c16 100644 --- a/docs/models/components/websearchuserlocation.mdx +++ b/docs/models/components/websearchuserlocation.mdx @@ -9,8 +9,8 @@ User location information for web search | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [*components.WebSearchUserLocationType](../../models/components/websearchuserlocationtype.mdx) | ➖ | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [*components.WebSearchUserLocationType](../../models/components/websearchuserlocationtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchuserlocationservertool.mdx b/docs/models/components/websearchuserlocationservertool.mdx index 2fc519c0b..a1e0de9e6 100644 --- a/docs/models/components/websearchuserlocationservertool.mdx +++ b/docs/models/components/websearchuserlocationservertool.mdx @@ -9,8 +9,8 @@ Approximate user location for location-biased results. | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | -| `Type` | [*components.WebSearchUserLocationServerToolType](../../models/components/websearchuserlocationservertooltype.mdx) | ➖ | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | +| `Type` | [*components.WebSearchUserLocationServerToolType](../../models/components/websearchuserlocationservertooltype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/workspace.mdx b/docs/models/components/workspace.mdx index f1f9afd4c..b1b975a5c 100644 --- a/docs/models/components/workspace.mdx +++ b/docs/models/components/workspace.mdx @@ -6,21 +6,21 @@ title: "Workspace" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | -| `CreatedBy` | `*string` | ✅ | User ID of the workspace creator | user_abc123 | -| `DefaultGuardrailID` | `string` | ✅ | Deterministic ID derived from the workspace ID. The default guardrail is materialized when its configuration is first written. | 595d5849-7e86-51fd-a7c0-705c34e4afff | -| `DefaultImageModel` | `*string` | ✅ | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | `*string` | ✅ | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | `*string` | ✅ | Default text model for this workspace | openai/gpt-4o | -| `Description` | `*string` | ✅ | Description of the workspace | Production environment workspace | -| `DisabledServerTools` | optionalnullable.OptionalNullable[[]`string`] | ➖ | OpenRouter server tools (e.g. openrouter:web_search) that requests in this workspace may not invoke. Null means no tools are disabled. | null | -| `ID` | `string` | ✅ | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | -| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) spend counts toward this workspace's budgets. Set it via the workspace budget endpoints. | false | -| `IoLoggingAPIKeyIds` | []`int64` | ✅ | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | -| `IoLoggingSamplingRate` | `float64` | ✅ | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | -| `IsDataDiscountLoggingEnabled` | `bool` | ✅ | Whether data discount logging is enabled for this workspace | true | -| `IsObservabilityBroadcastEnabled` | `bool` | ✅ | Whether broadcast is enabled for this workspace | false | -| `IsObservabilityIoLoggingEnabled` | `bool` | ✅ | Whether private logging is enabled for this workspace | false | -| `Name` | `string` | ✅ | Name of the workspace | Production | -| `Slug` | `string` | ✅ | URL-friendly slug for the workspace | production | -| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | +| `CreatedBy` | `*string` | :heavy_check_mark: | User ID of the workspace creator | user_abc123 | +| `DefaultGuardrailID` | `string` | :heavy_check_mark: | Deterministic ID derived from the workspace ID. The default guardrail is materialized when its configuration is first written. | 595d5849-7e86-51fd-a7c0-705c34e4afff | +| `DefaultImageModel` | `*string` | :heavy_check_mark: | Default image model for this workspace | openai/dall-e-3 | +| `DefaultProviderSort` | `*string` | :heavy_check_mark: | Default provider sort preference (price, throughput, latency, exacto) | price | +| `DefaultTextModel` | `*string` | :heavy_check_mark: | Default text model for this workspace | openai/gpt-4o | +| `Description` | `*string` | :heavy_check_mark: | Description of the workspace | Production environment workspace | +| `DisabledServerTools` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | OpenRouter server tools (e.g. openrouter:web_search) that requests in this workspace may not invoke. Null means no tools are disabled. | null | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | +| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend counts toward this workspace's budgets. Set it via the workspace budget endpoints. | false | +| `IoLoggingAPIKeyIds` | []`int64` | :heavy_check_mark: | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | +| `IoLoggingSamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | +| `IsDataDiscountLoggingEnabled` | `bool` | :heavy_check_mark: | Whether data discount logging is enabled for this workspace | true | +| `IsObservabilityBroadcastEnabled` | `bool` | :heavy_check_mark: | Whether broadcast is enabled for this workspace | false | +| `IsObservabilityIoLoggingEnabled` | `bool` | :heavy_check_mark: | Whether private logging is enabled for this workspace | false | +| `Name` | `string` | :heavy_check_mark: | Name of the workspace | Production | +| `Slug` | `string` | :heavy_check_mark: | URL-friendly slug for the workspace | production | +| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/docs/models/components/workspacebudget.mdx b/docs/models/components/workspacebudget.mdx index 749e2a183..07bb06ed8 100644 --- a/docs/models/components/workspacebudget.mdx +++ b/docs/models/components/workspacebudget.mdx @@ -6,9 +6,9 @@ title: "WorkspaceBudget" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | -| `ID` | `string` | ✅ | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | -| `LimitUsd` | `float64` | ✅ | Spending limit in USD for this interval | 100 | -| `ResetInterval` | [*components.ResetInterval](../../models/components/resetinterval.mdx) | ✅ | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | -| `UpdatedAt` | `string` | ✅ | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | ✅ | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | +| `LimitUsd` | `float64` | :heavy_check_mark: | Spending limit in USD for this interval | 100 | +| `ResetInterval` | [*components.ResetInterval](../../models/components/resetinterval.mdx) | :heavy_check_mark: | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | +| `UpdatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/workspacemember.mdx b/docs/models/components/workspacemember.mdx index 4dd2a99ec..1dcdc0b03 100644 --- a/docs/models/components/workspacemember.mdx +++ b/docs/models/components/workspacemember.mdx @@ -6,8 +6,8 @@ title: "WorkspaceMember" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | -| `ID` | `string` | ✅ | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `Role` | [components.WorkspaceMemberRole](../../models/components/workspacememberrole.mdx) | ✅ | Role of the member in the workspace | member | -| `UserID` | `string` | ✅ | Clerk user ID of the member | user_abc123 | -| `WorkspaceID` | `string` | ✅ | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | +| `ID` | `string` | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | +| `Role` | [components.WorkspaceMemberRole](../../models/components/workspacememberrole.mdx) | :heavy_check_mark: | Role of the member in the workspace | member | +| `UserID` | `string` | :heavy_check_mark: | Clerk user ID of the member | user_abc123 | +| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/xsearchoptions.mdx b/docs/models/components/xsearchoptions.mdx index e3cfa306b..4690aca2e 100644 --- a/docs/models/components/xsearchoptions.mdx +++ b/docs/models/components/xsearchoptions.mdx @@ -9,9 +9,9 @@ Enable SpaceXAI X (Twitter) search alongside native web search, with optional fi | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `AllowedXHandles` | []`string` | ➖ | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | -| `EnableImageUnderstanding` | `*bool` | ➖ | Analyze images attached to matching posts. | | -| `EnableVideoUnderstanding` | `*bool` | ➖ | Analyze videos attached to matching posts. | | -| `ExcludedXHandles` | []`string` | ➖ | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | -| `FromDate` | [*types.Date](../../types/date.mdx) | ➖ | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | -| `ToDate` | [*types.Date](../../types/date.mdx) | ➖ | End of the post date range (ISO 8601 date, e.g. "2025-12-31"). | 2025-12-31 | \ No newline at end of file +| `AllowedXHandles` | []`string` | :heavy_minus_sign: | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | +| `EnableImageUnderstanding` | `*bool` | :heavy_minus_sign: | Analyze images attached to matching posts. | | +| `EnableVideoUnderstanding` | `*bool` | :heavy_minus_sign: | Analyze videos attached to matching posts. | | +| `ExcludedXHandles` | []`string` | :heavy_minus_sign: | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | +| `FromDate` | [*types.Date](../../types/date.mdx) | :heavy_minus_sign: | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | +| `ToDate` | [*types.Date](../../types/date.mdx) | :heavy_minus_sign: | End of the post date range (ISO 8601 date, e.g. "2025-12-31"). | 2025-12-31 | \ No newline at end of file diff --git a/docs/models/operations/activateprivateendpointrequest.mdx b/docs/models/operations/activateprivateendpointrequest.mdx index b9a5d0a63..d3f3d2551 100644 --- a/docs/models/operations/activateprivateendpointrequest.mdx +++ b/docs/models/operations/activateprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "ActivatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/bulkaddworkspacemembersrequest.mdx b/docs/models/operations/bulkaddworkspacemembersrequest.mdx index 5d371843e..c33d12a56 100644 --- a/docs/models/operations/bulkaddworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkaddworkspacemembersrequest.mdx @@ -6,5 +6,5 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `BulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `BulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx index 9acbf7df7..664f49096 100644 --- a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "BulkAssignKeysToGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `BulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx index fd35fa90d..fcaab1b76 100644 --- a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "BulkAssignMembersToGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `BulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx index adbae1ccd..1333a3b4d 100644 --- a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx @@ -6,5 +6,5 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `BulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `BulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx index 2807faf3a..bc3a865a0 100644 --- a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "BulkUnassignKeysFromGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `BulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx index 1e96e9e3a..39f2fbf6a 100644 --- a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "BulkUnassignMembersFromGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `BulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/classifierdimensions.mdx b/docs/models/operations/classifierdimensions.mdx index 4068fadab..6d7eb45a5 100644 --- a/docs/models/operations/classifierdimensions.mdx +++ b/docs/models/operations/classifierdimensions.mdx @@ -9,6 +9,6 @@ Group results by custom classifier tags, breaking down metrics by the specified | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `ClassifierID` | `string` | ✅ | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | -| `DimensionNames` | []`string` | ➖ | N/A | | -| `IncludeNulls` | `*bool` | ➖ | When true, also include generations that have no tag from this classifier. Defaults to false, which returns only classified generations. | | \ No newline at end of file +| `ClassifierID` | `string` | :heavy_check_mark: | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | +| `DimensionNames` | []`string` | :heavy_minus_sign: | N/A | | +| `IncludeNulls` | `*bool` | :heavy_minus_sign: | When true, also include generations that have no tag from this classifier. Defaults to false, which returns only classified generations. | | \ No newline at end of file diff --git a/docs/models/operations/classifierfilters.mdx b/docs/models/operations/classifierfilters.mdx index 0674f9675..27444c7ed 100644 --- a/docs/models/operations/classifierfilters.mdx +++ b/docs/models/operations/classifierfilters.mdx @@ -9,5 +9,5 @@ Filter results to generations with specific classifier tag values. Can be combin | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `ClassifierID` | `string` | ✅ | UUID of the classifier whose tags to filter by. Must match classifier_dimensions.classifier_id when both are specified. | 550e8400-e29b-41d4-a716-446655440000 | -| `Filters` | [][operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter.mdx) | ✅ | N/A | | \ No newline at end of file +| `ClassifierID` | `string` | :heavy_check_mark: | UUID of the classifier whose tags to filter by. Must match classifier_dimensions.classifier_id when both are specified. | 550e8400-e29b-41d4-a716-446655440000 | +| `Filters` | [][operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/classifierfiltersfilter.mdx b/docs/models/operations/classifierfiltersfilter.mdx index 0106c3657..3e1d76509 100644 --- a/docs/models/operations/classifierfiltersfilter.mdx +++ b/docs/models/operations/classifierfiltersfilter.mdx @@ -6,6 +6,6 @@ title: "ClassifierFiltersFilter" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Field` | `string` | ✅ | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | -| `Operator` | `string` | ✅ | Filter operator. Only equality/set operators are supported (eq, neq, in, not_in) — ordered comparisons are not available because classification values are strings. | eq | -| `Value` | [operations.ClassifierFiltersValue](../../models/operations/classifierfiltersvalue.mdx) | ✅ | Filter value. Use a scalar (string or number) for eq/neq, or an array for in/not_in. | Engineering | \ No newline at end of file +| `Field` | `string` | :heavy_check_mark: | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | +| `Operator` | `string` | :heavy_check_mark: | Filter operator. Only equality/set operators are supported (eq, neq, in, not_in) — ordered comparisons are not available because classification values are strings. | eq | +| `Value` | [operations.ClassifierFiltersValue](../../models/operations/classifierfiltersvalue.mdx) | :heavy_check_mark: | Filter value. Use a scalar (string or number) for eq/neq, or an array for in/not_in. | Engineering | \ No newline at end of file diff --git a/docs/models/operations/contentimageurl.mdx b/docs/models/operations/contentimageurl.mdx index f43e3442c..316466ddd 100644 --- a/docs/models/operations/contentimageurl.mdx +++ b/docs/models/operations/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ImageURL` | [operations.ImageURL](../../models/operations/imageurl.mdx) | ✅ | N/A | -| `Type` | [operations.TypeImageURL](../../models/operations/typeimageurl.mdx) | ✅ | N/A | \ No newline at end of file +| `ImageURL` | [operations.ImageURL](../../models/operations/imageurl.mdx) | :heavy_check_mark: | N/A | +| `Type` | [operations.TypeImageURL](../../models/operations/typeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/contenttext.mdx b/docs/models/operations/contenttext.mdx index 24612167e..f9a90d0b5 100644 --- a/docs/models/operations/contenttext.mdx +++ b/docs/models/operations/contenttext.mdx @@ -6,5 +6,5 @@ title: "ContentText" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Text` | `string` | ✅ | N/A | -| `Type` | [operations.TypeText](../../models/operations/typetext.mdx) | ✅ | N/A | \ No newline at end of file +| `Text` | `string` | :heavy_check_mark: | N/A | +| `Type` | [operations.TypeText](../../models/operations/typetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/copyvaultsecretstointernrequest.mdx b/docs/models/operations/copyvaultsecretstointernrequest.mdx index 608363f43..8b2f9564c 100644 --- a/docs/models/operations/copyvaultsecretstointernrequest.mdx +++ b/docs/models/operations/copyvaultsecretstointernrequest.mdx @@ -6,5 +6,5 @@ title: "CopyVaultSecretsToInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `VaultSecretCopyRequest` | [components.VaultSecretCopyRequest](../../models/components/vaultsecretcopyrequest.mdx) | ✅ | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `VaultSecretCopyRequest` | [components.VaultSecretCopyRequest](../../models/components/vaultsecretcopyrequest.mdx) | :heavy_check_mark: | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx b/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx index 98240e106..94daa49e5 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx @@ -6,5 +6,5 @@ title: "CreateAudioTranscriptionsMultipartFile" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `FileName` | `string` | ✅ | N/A | -| `Content` | `any` | ✅ | N/A | \ No newline at end of file +| `FileName` | `string` | :heavy_check_mark: | N/A | +| `Content` | `any` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx index fff4f6310..490eee090 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx @@ -6,16 +6,16 @@ title: "CreateAudioTranscriptionsMultipartRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Diarize` | `*bool` | ➖ | Label each word with the speaker who said it (words[].speaker, words[].speaker_label). Requires response_format "verbose_json" (400 otherwise); word timestamps are included even when timestamp_granularities[] omits "word". Only supported by some providers; 400 when the selected model cannot diarize. | -| `File` | [*operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile.mdx) | ➖ | The audio file to transcribe. The format is derived from the filename extension or the file part content type. Max 25 MB; send larger files as base64 JSON via input_audio, or by URL via source_url. Exactly one of file or source_url is required. | -| `Keyterms` | []`string` | ➖ | Domain terms, names, or phrases to bias recognition toward; repeat the part once per term (keyterms=... is also accepted). Only supported by some providers; 400 when the selected model cannot use keyterms. | -| `Language` | `*string` | ➖ | The language of the input audio (ISO-639-1). | -| `Model` | `string` | ✅ | The model to use for transcription. | -| `Provider` | `*string` | ➖ | JSON-encoded provider preferences object, the same shape as the JSON body field: \{ "zdr": true, "data_collection": "deny", "options": \{ "\": \{ ... } } }. Only options for the matched provider are forwarded. Must decode to a JSON object. | -| `ResponseFormat` | [*operations.ResponseFormat](../../models/operations/responseformat.mdx) | ➖ | The response format. "json" (default) returns \{ text, usage }; "verbose_json" additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only). | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. | -| `SourceURL` | `*string` | ➖ | Publicly reachable http(s) URL of the audio file, downloaded by the provider directly (no size limit on our side). The format is derived from the URL path extension. Only supported by some providers; exactly one of file or source_url is required. | -| `Temperature` | `*float64` | ➖ | The sampling temperature. | -| `TimestampGranularities` | [][operations.TimestampGranularities](../../models/operations/timestampgranularities.mdx) | ➖ | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | -| `Trace` | `*string` | ➖ | JSON-encoded trace metadata object (trace_id, trace_name, span_name, generation_name, parent_span_id and custom keys) attached to the Broadcast trace. Must decode to a JSON object. | -| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | \ No newline at end of file +| `Diarize` | `*bool` | :heavy_minus_sign: | Label each word with the speaker who said it (words[].speaker, words[].speaker_label). Requires response_format "verbose_json" (400 otherwise); word timestamps are included even when timestamp_granularities[] omits "word". Only supported by some providers; 400 when the selected model cannot diarize. | +| `File` | [*operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile.mdx) | :heavy_minus_sign: | The audio file to transcribe. The format is derived from the filename extension or the file part content type. Max 25 MB; send larger files as base64 JSON via input_audio, or by URL via source_url. Exactly one of file or source_url is required. | +| `Keyterms` | []`string` | :heavy_minus_sign: | Domain terms, names, or phrases to bias recognition toward; repeat the part once per term (keyterms=... is also accepted). Only supported by some providers; 400 when the selected model cannot use keyterms. | +| `Language` | `*string` | :heavy_minus_sign: | The language of the input audio (ISO-639-1). | +| `Model` | `string` | :heavy_check_mark: | The model to use for transcription. | +| `Provider` | `*string` | :heavy_minus_sign: | JSON-encoded provider preferences object, the same shape as the JSON body field: \{ "zdr": true, "data_collection": "deny", "options": \{ "\": \{ ... } } }. Only options for the matched provider are forwarded. Must decode to a JSON object. | +| `ResponseFormat` | [*operations.ResponseFormat](../../models/operations/responseformat.mdx) | :heavy_minus_sign: | The response format. "json" (default) returns \{ text, usage }; "verbose_json" additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only). | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. | +| `SourceURL` | `*string` | :heavy_minus_sign: | Publicly reachable http(s) URL of the audio file, downloaded by the provider directly (no size limit on our side). The format is derived from the URL path extension. Only supported by some providers; exactly one of file or source_url is required. | +| `Temperature` | `*float64` | :heavy_minus_sign: | The sampling temperature. | +| `TimestampGranularities` | [][operations.TimestampGranularities](../../models/operations/timestampgranularities.mdx) | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | +| `Trace` | `*string` | :heavy_minus_sign: | JSON-encoded trace metadata object (trace_id, trace_name, span_name, generation_name, parent_span_id and custom keys) attached to the Broadcast trace. Must decode to a JSON object. | +| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscodedata.mdx b/docs/models/operations/createauthkeyscodedata.mdx index 26e35d493..309d665be 100644 --- a/docs/models/operations/createauthkeyscodedata.mdx +++ b/docs/models/operations/createauthkeyscodedata.mdx @@ -9,6 +9,6 @@ Auth code data | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `AppID` | `int64` | ✅ | The application ID associated with this auth code | 12345 | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | -| `ID` | `string` | ✅ | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file +| `AppID` | `int64` | :heavy_check_mark: | The application ID associated with this auth code | 12345 | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | +| `ID` | `string` | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderequest.mdx b/docs/models/operations/createauthkeyscoderequest.mdx index f4148f67e..4577c3334 100644 --- a/docs/models/operations/createauthkeyscoderequest.mdx +++ b/docs/models/operations/createauthkeyscoderequest.mdx @@ -6,11 +6,11 @@ title: "CreateAuthKeysCodeRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallbackURL` | `string` | ✅ | The callback URL to redirect to after authorization. Supports https URLs and localhost/127.0.0.1 URLs on any port for local CLI tools. | https://myapp.com/auth/callback | -| `CodeChallenge` | `*string` | ➖ | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `CodeChallengeMethod` | [*operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `KeyLabel` | `*string` | ➖ | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `Limit` | `*float64` | ➖ | Credit limit for the API key to be created | 100 | -| `UsageLimitType` | [*operations.UsageLimitType](../../models/operations/usagelimittype.mdx) | ➖ | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | -| `WorkspaceID` | `*string` | ➖ | Optional workspace ID to associate the API key with | | \ No newline at end of file +| `CallbackURL` | `string` | :heavy_check_mark: | The callback URL to redirect to after authorization. Supports https URLs and localhost/127.0.0.1 URLs on any port for local CLI tools. | https://myapp.com/auth/callback | +| `CodeChallenge` | `*string` | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | +| `CodeChallengeMethod` | [*operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `KeyLabel` | `*string` | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | +| `Limit` | `*float64` | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | +| `UsageLimitType` | [*operations.UsageLimitType](../../models/operations/usagelimittype.mdx) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to associate the API key with | | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderesponse.mdx b/docs/models/operations/createauthkeyscoderesponse.mdx index 00dad49a4..90fd1b3fa 100644 --- a/docs/models/operations/createauthkeyscoderesponse.mdx +++ b/docs/models/operations/createauthkeyscoderesponse.mdx @@ -9,4 +9,4 @@ Successfully created authorization code | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [operations.CreateAuthKeysCodeData](../../models/operations/createauthkeyscodedata.mdx) | ✅ | Auth code data | \{
"app_id": 12345,
"created_at": "2025-08-24T10:30:00Z",
"id": "auth_code_xyz789"
} | \ No newline at end of file +| `Data` | [operations.CreateAuthKeysCodeData](../../models/operations/createauthkeyscodedata.mdx) | :heavy_check_mark: | Auth code data | \{
"app_id": 12345,
"created_at": "2025-08-24T10:30:00Z",
"id": "auth_code_xyz789"
} | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsdata.mdx b/docs/models/operations/createembeddingsdata.mdx index 00829e7ae..297e417ac 100644 --- a/docs/models/operations/createembeddingsdata.mdx +++ b/docs/models/operations/createembeddingsdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Embedding` | [operations.Embedding](../../models/operations/embedding.mdx) | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `Index` | `*int64` | ➖ | Index of the embedding in the input list | 0 | -| `Object` | [operations.ObjectEmbedding](../../models/operations/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file +| `Embedding` | [operations.Embedding](../../models/operations/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `Index` | `*int64` | :heavy_minus_sign: | Index of the embedding in the input list | 0 | +| `Object` | [operations.ObjectEmbedding](../../models/operations/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsrequest.mdx b/docs/models/operations/createembeddingsrequest.mdx index 35dc4afba..2a36bede8 100644 --- a/docs/models/operations/createembeddingsrequest.mdx +++ b/docs/models/operations/createembeddingsrequest.mdx @@ -9,12 +9,12 @@ Embeddings request input | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Dimensions` | `*int64` | ➖ | The number of dimensions for the output embeddings | 1536 | -| `EncodingFormat` | [*operations.EncodingFormat](../../models/operations/encodingformat.mdx) | ➖ | The format of the output embeddings | float | -| `Input` | [operations.InputUnion](../../models/operations/inputunion.mdx) | ✅ | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `InputType` | `*string` | ➖ | The type of input (e.g. search_query, search_document) | search_query | -| `Model` | `string` | ✅ | The model to use for embeddings | openai/text-embedding-3-small | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | ➖ | A unique identifier for the end-user | user-1234 | \ No newline at end of file +| `Dimensions` | `*int64` | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | +| `EncodingFormat` | [*operations.EncodingFormat](../../models/operations/encodingformat.mdx) | :heavy_minus_sign: | The format of the output embeddings | float | +| `Input` | [operations.InputUnion](../../models/operations/inputunion.mdx) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | +| `InputType` | `*string` | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | +| `Model` | `string` | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsresponsebody.mdx b/docs/models/operations/createembeddingsresponsebody.mdx index a6e0ecf32..321bb0f0f 100644 --- a/docs/models/operations/createembeddingsresponsebody.mdx +++ b/docs/models/operations/createembeddingsresponsebody.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Data` | [][operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata.mdx) | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `ID` | `*string` | ➖ | Unique identifier for the embeddings response | embd-1234567890 | -| `Model` | `string` | ✅ | The model used for embeddings | openai/text-embedding-3-small | -| `Object` | [operations.Object](../../models/operations/object.mdx) | ✅ | N/A | | -| `Usage` | [*operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `Data` | [][operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata.mdx) | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `ID` | `*string` | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | +| `Model` | `string` | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | +| `Object` | [operations.Object](../../models/operations/object.mdx) | :heavy_check_mark: | N/A | | +| `Usage` | [*operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsusage.mdx b/docs/models/operations/createembeddingsusage.mdx index 798597f81..5cdc0579c 100644 --- a/docs/models/operations/createembeddingsusage.mdx +++ b/docs/models/operations/createembeddingsusage.mdx @@ -9,9 +9,9 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Cost` | `*float64` | ➖ | Cost of the request in credits | 0.0001 | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | -| `PromptTokens` | `int64` | ✅ | Number of tokens in the input | 8 | -| `PromptTokensDetails` | [*operations.PromptTokensDetails](../../models/operations/prompttokensdetails.mdx) | ➖ | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | -| `TotalTokens` | `int64` | ✅ | Total number of tokens used | 8 | \ No newline at end of file +| `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | +| `PromptTokens` | `int64` | :heavy_check_mark: | Number of tokens in the input | 8 | +| `PromptTokensDetails` | [*operations.PromptTokensDetails](../../models/operations/prompttokensdetails.mdx) | :heavy_minus_sign: | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | +| `TotalTokens` | `int64` | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/models/operations/createinternchatcompletionrequest.mdx b/docs/models/operations/createinternchatcompletionrequest.mdx index 4cee3b309..5cf4d6608 100644 --- a/docs/models/operations/createinternchatcompletionrequest.mdx +++ b/docs/models/operations/createinternchatcompletionrequest.mdx @@ -6,5 +6,5 @@ title: "CreateInternChatCompletionRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `InternID` | `string` | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `InternChatCompletionRequest` | [components.InternChatCompletionRequest](../../models/components/internchatcompletionrequest.mdx) | ✅ | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `InternChatCompletionRequest` | [components.InternChatCompletionRequest](../../models/components/internchatcompletionrequest.mdx) | :heavy_check_mark: | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | \ No newline at end of file diff --git a/docs/models/operations/createinternchatcompletionresponse.mdx b/docs/models/operations/createinternchatcompletionresponse.mdx index 42ed28f51..ae5d813fc 100644 --- a/docs/models/operations/createinternchatcompletionresponse.mdx +++ b/docs/models/operations/createinternchatcompletionresponse.mdx @@ -6,5 +6,5 @@ title: "CreateInternChatCompletionResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | ✅ | N/A | -| `Result` | [operations.CreateInternChatCompletionResponseResult](../../models/operations/createinternchatcompletionresponseresult.mdx) | ✅ | N/A | \ No newline at end of file +| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | +| `Result` | [operations.CreateInternChatCompletionResponseResult](../../models/operations/createinternchatcompletionresponseresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createinternrequest.mdx b/docs/models/operations/createinternrequest.mdx index 43b7ae194..812090510 100644 --- a/docs/models/operations/createinternrequest.mdx +++ b/docs/models/operations/createinternrequest.mdx @@ -6,5 +6,5 @@ title: "CreateInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IdempotencyKey` | `*string` | ➖ | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | -| `CreateInternRequest` | [components.CreateInternRequest](../../models/components/createinternrequest.mdx) | ✅ | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | \ No newline at end of file +| `IdempotencyKey` | `*string` | :heavy_minus_sign: | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | +| `CreateInternRequest` | [components.CreateInternRequest](../../models/components/createinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | \ No newline at end of file diff --git a/docs/models/operations/createkeysdata.mdx b/docs/models/operations/createkeysdata.mdx index 55c06bd83..4aaec927a 100644 --- a/docs/models/operations/createkeysdata.mdx +++ b/docs/models/operations/createkeysdata.mdx @@ -9,26 +9,26 @@ The created API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | ✅ | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `ExternalUser` | `*string` | ✅ | Partner's end-user identifier used for attribution. | null | -| `Hash` | `string` | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | -| `Name` | `string` | ✅ | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `ExternalUser` | `*string` | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | +| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | +| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/createkeysrequest.mdx b/docs/models/operations/createkeysrequest.mdx index 1080055c6..e0341964a 100644 --- a/docs/models/operations/createkeysrequest.mdx +++ b/docs/models/operations/createkeysrequest.mdx @@ -6,11 +6,11 @@ title: "CreateKeysRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatorUserID` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `External` | [*operations.External](../../models/operations/external.mdx) | ➖ | Optional partner-defined identity associated with the created API key. | | -| `IncludeBYOKInLimit` | `*bool` | ➖ | Whether to include BYOK usage in the limit | true | -| `Limit` | optionalnullable.OptionalNullable[`float64`] | ➖ | Optional spending limit for the API key in USD | 50 | -| `LimitReset` | optionalnullable.OptionalNullable[[operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset.mdx)] | ➖ | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | -| `Name` | `string` | ✅ | Name for the new API key | My New API Key | -| `WorkspaceID` | `*string` | ➖ | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `CreatorUserID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `External` | [*operations.External](../../models/operations/external.mdx) | :heavy_minus_sign: | Optional partner-defined identity associated with the created API key. | | +| `IncludeBYOKInLimit` | `*bool` | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | +| `Limit` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | +| `LimitReset` | optionalnullable.OptionalNullable[[operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset.mdx)] | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | +| `Name` | `string` | :heavy_check_mark: | Name for the new API key | My New API Key | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/createkeysresponse.mdx b/docs/models/operations/createkeysresponse.mdx index 6d183d1db..e35f6c24d 100644 --- a/docs/models/operations/createkeysresponse.mdx +++ b/docs/models/operations/createkeysresponse.mdx @@ -9,5 +9,5 @@ API key created successfully | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [operations.CreateKeysData](../../models/operations/createkeysdata.mdx) | ✅ | The created API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | -| `Key` | `string` | ✅ | The actual API key string (only shown once) | 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 | \ No newline at end of file +| `Data` | [operations.CreateKeysData](../../models/operations/createkeysdata.mdx) | :heavy_check_mark: | The created API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | +| `Key` | `string` | :heavy_check_mark: | The actual API key string (only shown once) | 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 | \ No newline at end of file diff --git a/docs/models/operations/createpresetschatcompletionsrequest.mdx b/docs/models/operations/createpresetschatcompletionsrequest.mdx index 1c9d6fdc9..1d0cf03af 100644 --- a/docs/models/operations/createpresetschatcompletionsrequest.mdx +++ b/docs/models/operations/createpresetschatcompletionsrequest.mdx @@ -6,5 +6,5 @@ title: "CreatePresetsChatCompletionsRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file +| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetsmessagesrequest.mdx b/docs/models/operations/createpresetsmessagesrequest.mdx index fb0a25627..30d1a19bc 100644 --- a/docs/models/operations/createpresetsmessagesrequest.mdx +++ b/docs/models/operations/createpresetsmessagesrequest.mdx @@ -6,5 +6,5 @@ title: "CreatePresetsMessagesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `MessagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest.mdx) | ✅ | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | \ No newline at end of file +| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `MessagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetsresponsesrequest.mdx b/docs/models/operations/createpresetsresponsesrequest.mdx index 61dc0be3d..6bb668f9e 100644 --- a/docs/models/operations/createpresetsresponsesrequest.mdx +++ b/docs/models/operations/createpresetsresponsesrequest.mdx @@ -6,5 +6,5 @@ title: "CreatePresetsResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file +| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file diff --git a/docs/models/operations/createprivateendpointrequest.mdx b/docs/models/operations/createprivateendpointrequest.mdx index 5e5266d31..fa8fcbf24 100644 --- a/docs/models/operations/createprivateendpointrequest.mdx +++ b/docs/models/operations/createprivateendpointrequest.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IdempotencyKey` | `*string` | ➖ | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | -| `CreatePrivateEndpointRequest` | [components.CreatePrivateEndpointRequest](../../models/components/createprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `IdempotencyKey` | `*string` | :heavy_minus_sign: | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | +| `CreatePrivateEndpointRequest` | [components.CreatePrivateEndpointRequest](../../models/components/createprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/creatererankrequest.mdx b/docs/models/operations/creatererankrequest.mdx index 760b4c654..2172a222f 100644 --- a/docs/models/operations/creatererankrequest.mdx +++ b/docs/models/operations/creatererankrequest.mdx @@ -9,11 +9,11 @@ Rerank request input | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Documents` | [][operations.Document](../../models/operations/document.mdx) | ✅ | The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | -| `Model` | `string` | ✅ | The rerank model to use | cohere/rerank-v3.5 | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | N/A | \{
"allow_fallbacks": true
} | -| `Query` | `string` | ✅ | The search query to rerank documents against | What is the capital of France? | -| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `TopN` | `*int64` | ➖ | Number of most relevant documents to return | 3 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `Documents` | [][operations.Document](../../models/operations/document.mdx) | :heavy_check_mark: | The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | +| `Model` | `string` | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `Query` | `string` | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | +| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `TopN` | `*int64` | :heavy_minus_sign: | Number of most relevant documents to return | 3 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/operations/creatererankresponsebody.mdx b/docs/models/operations/creatererankresponsebody.mdx index 812f9579d..d9d8a5dbd 100644 --- a/docs/models/operations/creatererankresponsebody.mdx +++ b/docs/models/operations/creatererankresponsebody.mdx @@ -9,8 +9,8 @@ Rerank response containing ranked results | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ID` | `*string` | ➖ | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | -| `Model` | `string` | ✅ | The model used for reranking | cohere/rerank-v3.5 | -| `Provider` | `*string` | ➖ | The provider that served the rerank request | Cohere | -| `Results` | [][operations.Result](../../models/operations/result.mdx) | ✅ | List of rerank results sorted by relevance | [
\{
"document": \{
"text": "Paris is the capital of France."
},
"index": 0,
"relevance_score": 0.98
}
] | -| `Usage` | [*operations.CreateRerankUsage](../../models/operations/creatererankusage.mdx) | ➖ | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file +| `ID` | `*string` | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | +| `Model` | `string` | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | +| `Provider` | `*string` | :heavy_minus_sign: | The provider that served the rerank request | Cohere | +| `Results` | [][operations.Result](../../models/operations/result.mdx) | :heavy_check_mark: | List of rerank results sorted by relevance | [
\{
"document": \{
"text": "Paris is the capital of France."
},
"index": 0,
"relevance_score": 0.98
}
] | +| `Usage` | [*operations.CreateRerankUsage](../../models/operations/creatererankusage.mdx) | :heavy_minus_sign: | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file diff --git a/docs/models/operations/creatererankusage.mdx b/docs/models/operations/creatererankusage.mdx index 2f8127ec7..f9934ff28 100644 --- a/docs/models/operations/creatererankusage.mdx +++ b/docs/models/operations/creatererankusage.mdx @@ -9,6 +9,6 @@ Usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `Cost` | `*float64` | ➖ | Cost of the request in credits | 0.001 | -| `SearchUnits` | `*int64` | ➖ | Number of search units consumed (Cohere billing) | 1 | -| `TotalTokens` | `*int64` | ➖ | Total number of tokens used | 150 | \ No newline at end of file +| `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.001 | +| `SearchUnits` | `*int64` | :heavy_minus_sign: | Number of search units consumed (Cohere billing) | 1 | +| `TotalTokens` | `*int64` | :heavy_minus_sign: | Total number of tokens used | 150 | \ No newline at end of file diff --git a/docs/models/operations/createresponsesrequest.mdx b/docs/models/operations/createresponsesrequest.mdx index 9d7795b93..3af4a4167 100644 --- a/docs/models/operations/createresponsesrequest.mdx +++ b/docs/models/operations/createresponsesrequest.mdx @@ -6,5 +6,5 @@ title: "CreateResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file +| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file diff --git a/docs/models/operations/createscimsyncjobresponse.mdx b/docs/models/operations/createscimsyncjobresponse.mdx index 9fd78a6a7..3105b213b 100644 --- a/docs/models/operations/createscimsyncjobresponse.mdx +++ b/docs/models/operations/createscimsyncjobresponse.mdx @@ -6,5 +6,5 @@ title: "CreateScimSyncJobResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | ✅ | N/A | -| `Result` | [components.CreateScimSyncJobResponse](../../models/components/createscimsyncjobresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | +| `Result` | [components.CreateScimSyncJobResponse](../../models/components/createscimsyncjobresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/deletebatchrequest.mdx b/docs/models/operations/deletebatchrequest.mdx index 70d2b1a75..eec48db98 100644 --- a/docs/models/operations/deletebatchrequest.mdx +++ b/docs/models/operations/deletebatchrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteBatchRequest" | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `ID` | `string` | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/models/operations/deletebyokkeyrequest.mdx b/docs/models/operations/deletebyokkeyrequest.mdx index c898aa437..d5e78b429 100644 --- a/docs/models/operations/deletebyokkeyrequest.mdx +++ b/docs/models/operations/deletebyokkeyrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/models/operations/deleteenduserrequest.mdx b/docs/models/operations/deleteenduserrequest.mdx index 5a3ce69e8..94e9f4d32 100644 --- a/docs/models/operations/deleteenduserrequest.mdx +++ b/docs/models/operations/deleteenduserrequest.mdx @@ -4,6 +4,6 @@ title: "DeleteEndUserRequest" ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file diff --git a/docs/models/operations/deletefilerequest.mdx b/docs/models/operations/deletefilerequest.mdx index 694972222..1167b1c09 100644 --- a/docs/models/operations/deletefilerequest.mdx +++ b/docs/models/operations/deletefilerequest.mdx @@ -6,6 +6,6 @@ title: "DeleteFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `FileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/deleteguardrailrequest.mdx b/docs/models/operations/deleteguardrailrequest.mdx index 8eb08ea42..a89dfc012 100644 --- a/docs/models/operations/deleteguardrailrequest.mdx +++ b/docs/models/operations/deleteguardrailrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `ID` | `string` | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/deleteinternrequest.mdx b/docs/models/operations/deleteinternrequest.mdx index 969a92eb3..1afa9fe2e 100644 --- a/docs/models/operations/deleteinternrequest.mdx +++ b/docs/models/operations/deleteinternrequest.mdx @@ -6,5 +6,5 @@ title: "DeleteInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `DeleteInternRequest` | [components.DeleteInternRequest](../../models/components/deleteinternrequest.mdx) | ✅ | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `DeleteInternRequest` | [components.DeleteInternRequest](../../models/components/deleteinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file diff --git a/docs/models/operations/deleteinternvaultsecretrequest.mdx b/docs/models/operations/deleteinternvaultsecretrequest.mdx index 5246355f4..276ef5144 100644 --- a/docs/models/operations/deleteinternvaultsecretrequest.mdx +++ b/docs/models/operations/deleteinternvaultsecretrequest.mdx @@ -6,5 +6,5 @@ title: "DeleteInternVaultSecretRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `Name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `Name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file diff --git a/docs/models/operations/deletekeysrequest.mdx b/docs/models/operations/deletekeysrequest.mdx index 34409f513..ed98c7c54 100644 --- a/docs/models/operations/deletekeysrequest.mdx +++ b/docs/models/operations/deletekeysrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Hash` | `string` | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/models/operations/deletekeysresponse.mdx b/docs/models/operations/deletekeysresponse.mdx index 8b98c2ee4..47d73b329 100644 --- a/docs/models/operations/deletekeysresponse.mdx +++ b/docs/models/operations/deletekeysresponse.mdx @@ -9,4 +9,4 @@ API key deleted successfully | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `Deleted` | `bool` | ✅ | Confirmation that the API key was deleted | true | \ No newline at end of file +| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/docs/models/operations/deleteobservabilitydestinationrequest.mdx b/docs/models/operations/deleteobservabilitydestinationrequest.mdx index 261205288..e9b969080 100644 --- a/docs/models/operations/deleteobservabilitydestinationrequest.mdx +++ b/docs/models/operations/deleteobservabilitydestinationrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/models/operations/deleteprivateendpointrequest.mdx b/docs/models/operations/deleteprivateendpointrequest.mdx index 17f8cd3bd..dec053747 100644 --- a/docs/models/operations/deleteprivateendpointrequest.mdx +++ b/docs/models/operations/deleteprivateendpointrequest.mdx @@ -6,5 +6,5 @@ title: "DeletePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `DraftOnly` | [*operations.DraftOnly](../../models/operations/draftonly.mdx) | ➖ | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `DraftOnly` | [*operations.DraftOnly](../../models/operations/draftonly.mdx) | :heavy_minus_sign: | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | \ No newline at end of file diff --git a/docs/models/operations/deletescimgroupmappingrequest.mdx b/docs/models/operations/deletescimgroupmappingrequest.mdx index a45b693af..13e0fc78a 100644 --- a/docs/models/operations/deletescimgroupmappingrequest.mdx +++ b/docs/models/operations/deletescimgroupmappingrequest.mdx @@ -6,5 +6,5 @@ title: "DeleteScimGroupMappingRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | N/A | | -| `KeepMembers` | [operations.KeepMembers](../../models/operations/keepmembers.mdx) | ✅ | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | | +| `KeepMembers` | [operations.KeepMembers](../../models/operations/keepmembers.mdx) | :heavy_check_mark: | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | \ No newline at end of file diff --git a/docs/models/operations/deletevaultsecretrequest.mdx b/docs/models/operations/deletevaultsecretrequest.mdx index 3f778906a..26eae4534 100644 --- a/docs/models/operations/deletevaultsecretrequest.mdx +++ b/docs/models/operations/deletevaultsecretrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteVaultSecretRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacebudgetrequest.mdx b/docs/models/operations/deleteworkspacebudgetrequest.mdx index 37bc8bb00..50c31c754 100644 --- a/docs/models/operations/deleteworkspacebudgetrequest.mdx +++ b/docs/models/operations/deleteworkspacebudgetrequest.mdx @@ -6,5 +6,5 @@ title: "DeleteWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `WorkspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file +| `WorkspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacerequest.mdx b/docs/models/operations/deleteworkspacerequest.mdx index 2f9df026c..76bee53e8 100644 --- a/docs/models/operations/deleteworkspacerequest.mdx +++ b/docs/models/operations/deleteworkspacerequest.mdx @@ -6,5 +6,5 @@ title: "DeleteWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `ConfirmDefaultWorkspaceDeletion` | `*bool` | ➖ | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `ConfirmDefaultWorkspaceDeletion` | `*bool` | :heavy_minus_sign: | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | \ No newline at end of file diff --git a/docs/models/operations/dimension.mdx b/docs/models/operations/dimension.mdx index f38e616ee..2f6ade1b0 100644 --- a/docs/models/operations/dimension.mdx +++ b/docs/models/operations/dimension.mdx @@ -6,5 +6,5 @@ title: "Dimension" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `DisplayLabel` | `string` | ✅ | Human-readable label | Model | -| `Name` | `string` | ✅ | Dimension identifier used in query requests | model | \ No newline at end of file +| `DisplayLabel` | `string` | :heavy_check_mark: | Human-readable label | Model | +| `Name` | `string` | :heavy_check_mark: | Dimension identifier used in query requests | model | \ No newline at end of file diff --git a/docs/models/operations/disableprivateendpointrequest.mdx b/docs/models/operations/disableprivateendpointrequest.mdx index e87d68061..50d492737 100644 --- a/docs/models/operations/disableprivateendpointrequest.mdx +++ b/docs/models/operations/disableprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "DisablePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/documentrequest.mdx b/docs/models/operations/documentrequest.mdx index 2fe807485..dde687d58 100644 --- a/docs/models/operations/documentrequest.mdx +++ b/docs/models/operations/documentrequest.mdx @@ -9,5 +9,5 @@ A structured document with optional text and/or image content. At least one of ` | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Image` | `*string` | ➖ | An image associated with the document, as a remote URL (http/https) or a base64-encoded data URI (data:image/...). | https://upload.wikimedia.org/wikipedia/commons/thumb/8/8b/Phytogenic.png | -| `Text` | `*string` | ➖ | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file +| `Image` | `*string` | :heavy_minus_sign: | An image associated with the document, as a remote URL (http/https) or a base64-encoded data URI (data:image/...). | https://upload.wikimedia.org/wikipedia/commons/thumb/8/8b/Phytogenic.png | +| `Text` | `*string` | :heavy_minus_sign: | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file diff --git a/docs/models/operations/documentresponse.mdx b/docs/models/operations/documentresponse.mdx index f0f9dd4e0..8fa1f1795 100644 --- a/docs/models/operations/documentresponse.mdx +++ b/docs/models/operations/documentresponse.mdx @@ -9,5 +9,5 @@ The document object echoing the original input (text and/or image) | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `Image` | `*string` | ➖ | The image (URL or data URI) from the original document | https://example.com/image.png | -| `Text` | `*string` | ➖ | The document text | Paris is the capital of France. | \ No newline at end of file +| `Image` | `*string` | :heavy_minus_sign: | The image (URL or data URI) from the original document | https://example.com/image.png | +| `Text` | `*string` | :heavy_minus_sign: | The document text | Paris is the capital of France. | \ No newline at end of file diff --git a/docs/models/operations/downloadcontainerfilecontentrequest.mdx b/docs/models/operations/downloadcontainerfilecontentrequest.mdx index e56d30e0c..67d867374 100644 --- a/docs/models/operations/downloadcontainerfilecontentrequest.mdx +++ b/docs/models/operations/downloadcontainerfilecontentrequest.mdx @@ -6,5 +6,5 @@ title: "DownloadContainerFileContentRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `FileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `FileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/downloadfilecontentrequest.mdx b/docs/models/operations/downloadfilecontentrequest.mdx index ddd67d891..6f311f374 100644 --- a/docs/models/operations/downloadfilecontentrequest.mdx +++ b/docs/models/operations/downloadfilecontentrequest.mdx @@ -6,6 +6,6 @@ title: "DownloadFileContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `FileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/enableprivateendpointrequest.mdx b/docs/models/operations/enableprivateendpointrequest.mdx index 8f29c4906..6abebf4fd 100644 --- a/docs/models/operations/enableprivateendpointrequest.mdx +++ b/docs/models/operations/enableprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "EnablePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx index 023ef1c82..728bab699 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx @@ -6,6 +6,6 @@ title: "ExchangeAuthCodeForAPIKeyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Code` | `string` | ✅ | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `CodeChallengeMethod` | optionalnullable.OptionalNullable[[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod.mdx)] | ➖ | The method used to generate the code challenge | S256 | -| `CodeVerifier` | `*string` | ➖ | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | \ No newline at end of file +| `Code` | `string` | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | +| `CodeChallengeMethod` | optionalnullable.OptionalNullable[[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod.mdx)] | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `CodeVerifier` | `*string` | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx b/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx index 4dc064e10..09ca68538 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx @@ -9,5 +9,5 @@ Successfully exchanged code for an API key | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Key` | `string` | ✅ | The API key to use for OpenRouter requests | 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 | -| `UserID` | `*string` | ✅ | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file +| `Key` | `string` | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | +| `UserID` | `*string` | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/docs/models/operations/external.mdx b/docs/models/operations/external.mdx index 253501b1e..8ac7dfaa3 100644 --- a/docs/models/operations/external.mdx +++ b/docs/models/operations/external.mdx @@ -9,5 +9,5 @@ Optional partner-defined identity associated with the created API key. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKey` | `*string` | ➖ | Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned. | | -| `User` | `string` | ✅ | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file +| `APIKey` | `*string` | :heavy_minus_sign: | Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned. | | +| `User` | `string` | :heavy_check_mark: | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file diff --git a/docs/models/operations/filter.mdx b/docs/models/operations/filter.mdx index 33f54c268..928761d40 100644 --- a/docs/models/operations/filter.mdx +++ b/docs/models/operations/filter.mdx @@ -6,7 +6,7 @@ title: "Filter" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Field` | `string` | ✅ | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | -| `IncludeUnset` | `*bool` | ➖ | Include rows where the dimension has no value. Applies only to the `in` and `not_in` operators and dimensions that have an unset bucket. | | -| `Operator` | `string` | ✅ | Filter operator | eq | -| `Value` | [operations.Value1](../../models/operations/value1.mdx) | ✅ | Filter value (scalar or array depending on operator). Several dimensions are enriched in responses (returned as human-readable labels), but filters must use the underlying ID: `api_key_id` — numeric ID (from generation metadata) or key hash (64-char hex from GET /api/v1/keys, resolved server-side); `user` — Clerk user ID (e.g. "user_abc123"), not the display name; `workspace` — workspace UUID, not the workspace name (filtering or grouping by the account default workspace also covers activity recorded before workspace resolution existed, which is attributed to that default workspace); `app` — numeric app ID, not the app title; `model` — permaslug (e.g. "openai/gpt-4o"), not the display name. Other dimensions (provider, origin, country, etc.) are not enriched and accept the value as returned. | | \ No newline at end of file +| `Field` | `string` | :heavy_check_mark: | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | +| `IncludeUnset` | `*bool` | :heavy_minus_sign: | Include rows where the dimension has no value. Applies only to the `in` and `not_in` operators and dimensions that have an unset bucket. | | +| `Operator` | `string` | :heavy_check_mark: | Filter operator | eq | +| `Value` | [operations.Value1](../../models/operations/value1.mdx) | :heavy_check_mark: | Filter value (scalar or array depending on operator). Several dimensions are enriched in responses (returned as human-readable labels), but filters must use the underlying ID: `api_key_id` — numeric ID (from generation metadata) or key hash (64-char hex from GET /api/v1/keys, resolved server-side); `user` — Clerk user ID (e.g. "user_abc123"), not the display name; `workspace` — workspace UUID, not the workspace name (filtering or grouping by the account default workspace also covers activity recorded before workspace resolution existed, which is attributed to that default workspace); `app` — numeric app ID, not the app title; `model` — permaslug (e.g. "openai/gpt-4o"), not the display name. Other dimensions (provider, origin, country, etc.) are not enriched and accept the value as returned. | | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetadata.mdx b/docs/models/operations/getanalyticsmetadata.mdx index 4e444c9e6..d984d60ef 100644 --- a/docs/models/operations/getanalyticsmetadata.mdx +++ b/docs/models/operations/getanalyticsmetadata.mdx @@ -6,7 +6,7 @@ title: "GetAnalyticsMetaData" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Dimensions` | [][operations.Dimension](../../models/operations/dimension.mdx) | ✅ | N/A | -| `Granularities` | [][operations.Granularity](../../models/operations/granularity.mdx) | ✅ | N/A | -| `Metrics` | [][operations.Metric](../../models/operations/metric.mdx) | ✅ | N/A | -| `Operators` | [][operations.Operator](../../models/operations/operator.mdx) | ✅ | N/A | \ No newline at end of file +| `Dimensions` | [][operations.Dimension](../../models/operations/dimension.mdx) | :heavy_check_mark: | N/A | +| `Granularities` | [][operations.Granularity](../../models/operations/granularity.mdx) | :heavy_check_mark: | N/A | +| `Metrics` | [][operations.Metric](../../models/operations/metric.mdx) | :heavy_check_mark: | N/A | +| `Operators` | [][operations.Operator](../../models/operations/operator.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetaresponse.mdx b/docs/models/operations/getanalyticsmetaresponse.mdx index a54dcc403..3c59f3543 100644 --- a/docs/models/operations/getanalyticsmetaresponse.mdx +++ b/docs/models/operations/getanalyticsmetaresponse.mdx @@ -9,4 +9,4 @@ Returns analytics query metadata | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Data` | [operations.GetAnalyticsMetaData](../../models/operations/getanalyticsmetadata.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [operations.GetAnalyticsMetaData](../../models/operations/getanalyticsmetadata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getapprankingsrequest.mdx b/docs/models/operations/getapprankingsrequest.mdx index 09f3ba851..062c2050c 100644 --- a/docs/models/operations/getapprankingsrequest.mdx +++ b/docs/models/operations/getapprankingsrequest.mdx @@ -6,10 +6,10 @@ title: "GetAppRankingsRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Category` | [*operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory.mdx) | ➖ | Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group. | coding | -| `Subcategory` | [*operations.Subcategory](../../models/operations/subcategory.mdx) | ➖ | Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent. | cli-agent | -| `Sort` | [*operations.GetAppRankingsSort](../../models/operations/getapprankingssort.mdx) | ➖ | `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results. | popular | -| `StartDate` | `*string` | ➖ | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | -| `EndDate` | `*string` | ➖ | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | -| `Limit` | `*int64` | ➖ | Maximum number of apps to return (1-100). Defaults to 50. | 50 | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`. | 0 | \ No newline at end of file +| `Category` | [*operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory.mdx) | :heavy_minus_sign: | Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group. | coding | +| `Subcategory` | [*operations.Subcategory](../../models/operations/subcategory.mdx) | :heavy_minus_sign: | Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent. | cli-agent | +| `Sort` | [*operations.GetAppRankingsSort](../../models/operations/getapprankingssort.mdx) | :heavy_minus_sign: | `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results. | popular | +| `StartDate` | `*string` | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | +| `EndDate` | `*string` | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`. | 0 | \ No newline at end of file diff --git a/docs/models/operations/getapprankingsresponse.mdx b/docs/models/operations/getapprankingsresponse.mdx index bf0c5da30..e1bd436e3 100644 --- a/docs/models/operations/getapprankingsresponse.mdx +++ b/docs/models/operations/getapprankingsresponse.mdx @@ -6,4 +6,4 @@ title: "GetAppRankingsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.AppRankingsResponse](../../models/components/apprankingsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"app_id": 12345,
"app_name": "Cline",
"rank": 1,
"total_requests": 4321,
"total_tokens": "12345678"
},
\{
"app_id": 67890,
"app_name": "Roo Code",
"rank": 2,
"total_requests": 2109,
"total_tokens": "9876543"
}
],
"meta": \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file +| `Result` | [components.AppRankingsResponse](../../models/components/apprankingsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"app_id": 12345,
"app_name": "Cline",
"rank": 1,
"total_requests": 4321,
"total_tokens": "12345678"
},
\{
"app_id": 67890,
"app_name": "Roo Code",
"rank": 2,
"total_requests": 2109,
"total_tokens": "9876543"
}
],
"meta": \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file diff --git a/docs/models/operations/getbatchesrequest.mdx b/docs/models/operations/getbatchesrequest.mdx index 92c68a92c..b3f3e9b10 100644 --- a/docs/models/operations/getbatchesrequest.mdx +++ b/docs/models/operations/getbatchesrequest.mdx @@ -6,4 +6,4 @@ title: "GetBatchesRequest" | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `ID` | `string` | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/models/operations/getbenchmarksrequest.mdx b/docs/models/operations/getbenchmarksrequest.mdx index b8ea3b585..256e326ac 100644 --- a/docs/models/operations/getbenchmarksrequest.mdx +++ b/docs/models/operations/getbenchmarksrequest.mdx @@ -6,12 +6,12 @@ title: "GetBenchmarksRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Source` | [*operations.Source](../../models/operations/source.mdx) | ➖ | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | -| `TaskType` | [*operations.TaskType](../../models/operations/tasktype.mdx) | ➖ | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. `search` returns OpenRouter search benchmark results only. | coding | -| `BenchmarkType` | [*operations.BenchmarkType](../../models/operations/benchmarktype.mdx) | ➖ | Return results for one exact OpenRouter benchmark. A `search_*` value narrows the response to search results only; a classic value narrows the OpenRouter items and leaves other sources' items as they are. | search_widesearch | -| `IncludeRunConfig` | `*bool` | ➖ | Search benchmarks only: include the published lane configuration whitelist in each search item. Defaults to false. The whitelist is limited to agent turn count, reasoning effort, and temperature so future harness configuration changes do not change the public contract. | true | -| `SearchEngine` | `*string` | ➖ | OpenRouter search benchmarks only: filter by the search engine used. | exa | -| `SearchSurface` | [*operations.SearchSurface](../../models/operations/searchsurface.mdx) | ➖ | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | -| `Arena` | [*operations.Arena](../../models/operations/arena.mdx) | ➖ | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | -| `Category` | `*string` | ➖ | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | -| `MaxResults` | `*int64` | ➖ | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file +| `Source` | [*operations.Source](../../models/operations/source.mdx) | :heavy_minus_sign: | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | +| `TaskType` | [*operations.TaskType](../../models/operations/tasktype.mdx) | :heavy_minus_sign: | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. `search` returns OpenRouter search benchmark results only. | coding | +| `BenchmarkType` | [*operations.BenchmarkType](../../models/operations/benchmarktype.mdx) | :heavy_minus_sign: | Return results for one exact OpenRouter benchmark. A `search_*` value narrows the response to search results only; a classic value narrows the OpenRouter items and leaves other sources' items as they are. | search_widesearch | +| `IncludeRunConfig` | `*bool` | :heavy_minus_sign: | Search benchmarks only: include the published lane configuration whitelist in each search item. Defaults to false. The whitelist is limited to agent turn count, reasoning effort, and temperature so future harness configuration changes do not change the public contract. | true | +| `SearchEngine` | `*string` | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the search engine used. | exa | +| `SearchSurface` | [*operations.SearchSurface](../../models/operations/searchsurface.mdx) | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | +| `Arena` | [*operations.Arena](../../models/operations/arena.mdx) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | +| `Category` | `*string` | :heavy_minus_sign: | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | +| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file diff --git a/docs/models/operations/getbyokkeyrequest.mdx b/docs/models/operations/getbyokkeyrequest.mdx index 8f82cd9d7..a89b223c2 100644 --- a/docs/models/operations/getbyokkeyrequest.mdx +++ b/docs/models/operations/getbyokkeyrequest.mdx @@ -6,4 +6,4 @@ title: "GetBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/models/operations/getcontainerfilerequest.mdx b/docs/models/operations/getcontainerfilerequest.mdx index 402ea6e01..4799b6493 100644 --- a/docs/models/operations/getcontainerfilerequest.mdx +++ b/docs/models/operations/getcontainerfilerequest.mdx @@ -6,5 +6,5 @@ title: "GetContainerFileRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `FileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `FileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/getcreditsdata.mdx b/docs/models/operations/getcreditsdata.mdx index 79c61fe3b..25280a314 100644 --- a/docs/models/operations/getcreditsdata.mdx +++ b/docs/models/operations/getcreditsdata.mdx @@ -6,5 +6,5 @@ title: "GetCreditsData" | Field | Type | Required | Description | Example | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `TotalCredits` | `float64` | ✅ | Total credits purchased | 100.5 | -| `TotalUsage` | `float64` | ✅ | Total credits used | 25.75 | \ No newline at end of file +| `TotalCredits` | `float64` | :heavy_check_mark: | Total credits purchased | 100.5 | +| `TotalUsage` | `float64` | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file diff --git a/docs/models/operations/getcreditsresponse.mdx b/docs/models/operations/getcreditsresponse.mdx index 89a735654..11dc4d56f 100644 --- a/docs/models/operations/getcreditsresponse.mdx +++ b/docs/models/operations/getcreditsresponse.mdx @@ -9,4 +9,4 @@ Total credits purchased and used | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Data` | [operations.GetCreditsData](../../models/operations/getcreditsdata.mdx) | ✅ | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file +| `Data` | [operations.GetCreditsData](../../models/operations/getcreditsdata.mdx) | :heavy_check_mark: | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeydata.mdx b/docs/models/operations/getcurrentkeydata.mdx index 3a243cbe5..686566822 100644 --- a/docs/models/operations/getcurrentkeydata.mdx +++ b/docs/models/operations/getcurrentkeydata.mdx @@ -9,26 +9,26 @@ Current API key information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDataRegions` | [][operations.AllowedDataRegion](../../models/operations/alloweddataregion.mdx) | ✅ | Data regions permitted for this API key by the guardrail policies on the key and the account regional-routing entitlement. Empty when no region is permitted. Reflects region policy only: other key restrictions, such as management keys being blocked from inference, still apply. | [
"global",
"europe",
"us"
] | -| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `FreeModelDailyRequests` | [components.FreeModelDailyRequests](../../models/components/freemodeldailyrequests.mdx) | ✅ | Free-model (`:free` variant) daily request quota for the account that owns the key. Reports the same counter and tier limit that free-model enforcement reads for accounts subject to the free-model limits; the counter resets at UTC midnight. Accounts and endpoints exempt from free-model limits, and BYOK requests, are not gated by it, so `remaining` is the tier policy rather than an enforced ceiling for them. | \{
"limit": 50,
"remaining": 38,
"used": 12
} | -| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `IsFreeTier` | `bool` | ✅ | Whether this is a free tier API key | false | -| `IsManagementKey` | `bool` | ✅ | Whether this is a management key | false | -| ~~`IsProvisioningKey`~~ | `bool` | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | -| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | -| `OrganizationID` | `*string` | ✅ | The ID of the organization that owns this API key, or null when an individual account owns it. | null | -| ~~`RateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit.mdx) | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Legacy rate limit information about a key. Will always return -1. | \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
} | -| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `*string` | ✅ | The ID of the workspace this API key spends in, or null when no active workspace resolved for it, for example because the key's workspace was deleted. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `AllowedDataRegions` | [][operations.AllowedDataRegion](../../models/operations/alloweddataregion.mdx) | :heavy_check_mark: | Data regions permitted for this API key by the guardrail policies on the key and the account regional-routing entitlement. Empty when no region is permitted. Reflects region policy only: other key restrictions, such as management keys being blocked from inference, still apply. | [
"global",
"europe",
"us"
] | +| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `FreeModelDailyRequests` | [components.FreeModelDailyRequests](../../models/components/freemodeldailyrequests.mdx) | :heavy_check_mark: | Free-model (`:free` variant) daily request quota for the account that owns the key. Reports the same counter and tier limit that free-model enforcement reads for accounts subject to the free-model limits; the counter resets at UTC midnight. Accounts and endpoints exempt from free-model limits, and BYOK requests, are not gated by it, so `remaining` is the tier policy rather than an enforced ceiling for them. | \{
"limit": 50,
"remaining": 38,
"used": 12
} | +| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `IsFreeTier` | `bool` | :heavy_check_mark: | Whether this is a free tier API key | false | +| `IsManagementKey` | `bool` | :heavy_check_mark: | Whether this is a management key | false | +| ~~`IsProvisioningKey`~~ | `bool` | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | +| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `OrganizationID` | `*string` | :heavy_check_mark: | The ID of the organization that owns this API key, or null when an individual account owns it. | null | +| ~~`RateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit.mdx) | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Legacy rate limit information about a key. Will always return -1. | \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
} | +| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `*string` | :heavy_check_mark: | The ID of the workspace this API key spends in, or null when no active workspace resolved for it, for example because the key's workspace was deleted. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeyresponse.mdx b/docs/models/operations/getcurrentkeyresponse.mdx index 83fd3451c..0631c3dfe 100644 --- a/docs/models/operations/getcurrentkeyresponse.mdx +++ b/docs/models/operations/getcurrentkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata.mdx) | ✅ | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"expires_at": "2027-12-31T23:59:59Z",
"free_model_daily_requests": \{
"limit": 50,
"remaining": 38,
"used": 12
},
"include_byok_in_limit": false,
"is_free_tier": false,
"is_management_key": false,
"is_provisioning_key": false,
"label": "sk-or-v1-au7...890",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"rate_limit": \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
},
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5
} | \ No newline at end of file +| `Data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata.mdx) | :heavy_check_mark: | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"expires_at": "2027-12-31T23:59:59Z",
"free_model_daily_requests": \{
"limit": 50,
"remaining": 38,
"used": 12
},
"include_byok_in_limit": false,
"is_free_tier": false,
"is_management_key": false,
"is_provisioning_key": false,
"label": "sk-or-v1-au7...890",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"rate_limit": \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
},
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5
} | \ No newline at end of file diff --git a/docs/models/operations/getenduserrequest.mdx b/docs/models/operations/getenduserrequest.mdx index dc4f8e92c..432f641e0 100644 --- a/docs/models/operations/getenduserrequest.mdx +++ b/docs/models/operations/getenduserrequest.mdx @@ -4,6 +4,6 @@ title: "GetEndUserRequest" ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file diff --git a/docs/models/operations/getfilemetadatarequest.mdx b/docs/models/operations/getfilemetadatarequest.mdx index d78f1a667..f75dd8493 100644 --- a/docs/models/operations/getfilemetadatarequest.mdx +++ b/docs/models/operations/getfilemetadatarequest.mdx @@ -6,6 +6,6 @@ title: "GetFileMetadataRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `FileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `FileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/getgenerationrequest.mdx b/docs/models/operations/getgenerationrequest.mdx index eaed892c9..fffa9af2d 100644 --- a/docs/models/operations/getgenerationrequest.mdx +++ b/docs/models/operations/getgenerationrequest.mdx @@ -6,4 +6,4 @@ title: "GetGenerationRequest" | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/models/operations/getguardrailrequest.mdx b/docs/models/operations/getguardrailrequest.mdx index 684137c8b..f66e886eb 100644 --- a/docs/models/operations/getguardrailrequest.mdx +++ b/docs/models/operations/getguardrailrequest.mdx @@ -6,4 +6,4 @@ title: "GetGuardrailRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `ID` | `string` | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/getinterndaemonaccessrequest.mdx b/docs/models/operations/getinterndaemonaccessrequest.mdx index a05847c1d..fcddf168a 100644 --- a/docs/models/operations/getinterndaemonaccessrequest.mdx +++ b/docs/models/operations/getinterndaemonaccessrequest.mdx @@ -6,4 +6,4 @@ title: "GetInternDaemonAccessRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getinterndaemonrequest.mdx b/docs/models/operations/getinterndaemonrequest.mdx index b0bed2a70..0194b7a0b 100644 --- a/docs/models/operations/getinterndaemonrequest.mdx +++ b/docs/models/operations/getinterndaemonrequest.mdx @@ -6,4 +6,4 @@ title: "GetInternDaemonRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getinternrequest.mdx b/docs/models/operations/getinternrequest.mdx index 9a9cc7e87..ccfda3818 100644 --- a/docs/models/operations/getinternrequest.mdx +++ b/docs/models/operations/getinternrequest.mdx @@ -6,4 +6,4 @@ title: "GetInternRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getkeydata.mdx b/docs/models/operations/getkeydata.mdx index 006a53a4b..bf565b953 100644 --- a/docs/models/operations/getkeydata.mdx +++ b/docs/models/operations/getkeydata.mdx @@ -9,26 +9,26 @@ The API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | ✅ | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `ExternalUser` | `*string` | ✅ | Partner's end-user identifier used for attribution. | null | -| `Hash` | `string` | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | -| `Name` | `string` | ✅ | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `ExternalUser` | `*string` | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | +| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | +| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/getkeyrequest.mdx b/docs/models/operations/getkeyrequest.mdx index 0117d7c4c..365e1df5d 100644 --- a/docs/models/operations/getkeyrequest.mdx +++ b/docs/models/operations/getkeyrequest.mdx @@ -6,4 +6,4 @@ title: "GetKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Hash` | `string` | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/models/operations/getkeyresponse.mdx b/docs/models/operations/getkeyresponse.mdx index 31ef24b76..127ba142f 100644 --- a/docs/models/operations/getkeyresponse.mdx +++ b/docs/models/operations/getkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [operations.GetKeyData](../../models/operations/getkeydata.mdx) | ✅ | The API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [operations.GetKeyData](../../models/operations/getkeydata.mdx) | :heavy_check_mark: | The API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/operations/getmodelrequest.mdx b/docs/models/operations/getmodelrequest.mdx index f9bba6641..576eb6b1e 100644 --- a/docs/models/operations/getmodelrequest.mdx +++ b/docs/models/operations/getmodelrequest.mdx @@ -6,5 +6,5 @@ title: "GetModelRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Author` | `string` | ✅ | The author/organization of the model | openai | -| `Slug` | `string` | ✅ | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | \ No newline at end of file +| `Author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | +| `Slug` | `string` | :heavy_check_mark: | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | \ No newline at end of file diff --git a/docs/models/operations/getmodelsrequest.mdx b/docs/models/operations/getmodelsrequest.mdx index ab38567d1..14caaa839 100644 --- a/docs/models/operations/getmodelsrequest.mdx +++ b/docs/models/operations/getmodelsrequest.mdx @@ -6,32 +6,32 @@ title: "GetModelsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `Category` | [*operations.GetModelsCategory](../../models/operations/getmodelscategory.mdx) | ➖ | Filter models by use case category | programming | -| `SupportedParameters` | `*string` | ➖ | Filter models by supported parameter (comma-separated) | temperature | -| `OutputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | -| `Sort` | [*operations.GetModelsSort](../../models/operations/getmodelssort.mdx) | ➖ | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. | newest | -| `Q` | `*string` | ➖ | Free-text search by model name or slug. | gpt-4 | -| `InputModalities` | `*string` | ➖ | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | -| `Context` | `*int64` | ➖ | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | -| `MinPrice` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum prompt price in $/M tokens. | 0 | -| `MaxPrice` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum prompt price in $/M tokens. | 10 | -| `Arch` | `*string` | ➖ | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | -| `ModelAuthors` | `*string` | ➖ | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | -| `Providers` | `*string` | ➖ | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | -| `Distillable` | [*operations.Distillable](../../models/operations/distillable.mdx) | ➖ | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | -| `Zdr` | [*operations.Zdr](../../models/operations/zdr.mdx) | ➖ | When set to "true", return only models with zero data retention endpoints. | true | -| `Region` | [*operations.Region](../../models/operations/region.mdx) | ➖ | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | -| `MinOutputPrice` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum completion (output) price in $/M tokens. | 0 | -| `MaxOutputPrice` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum completion (output) price in $/M tokens. | 10 | -| `MinAgeDays` | optionalnullable.OptionalNullable[`int64`] | ➖ | Minimum model age in days since its creation date. | 0 | -| `MaxAgeDays` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum model age in days since its creation date. | 90 | -| `MinIntelligenceIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum Artificial Analysis intelligence index. | 50 | -| `MaxIntelligenceIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum Artificial Analysis intelligence index. | 100 | -| `MinCodingIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum Artificial Analysis coding index. | 50 | -| `MaxCodingIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum Artificial Analysis coding index. | 100 | -| `MinAgenticIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum Artificial Analysis agentic index. | 50 | -| `MaxAgenticIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum Artificial Analysis agentic index. | 100 | -| `MinToolSuccessRate` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). | 0.9 | -| `MaxToolSuccessRate` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `Category` | [*operations.GetModelsCategory](../../models/operations/getmodelscategory.mdx) | :heavy_minus_sign: | Filter models by use case category | programming | +| `SupportedParameters` | `*string` | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | +| `OutputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | +| `Sort` | [*operations.GetModelsSort](../../models/operations/getmodelssort.mdx) | :heavy_minus_sign: | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. | newest | +| `Q` | `*string` | :heavy_minus_sign: | Free-text search by model name or slug. | gpt-4 | +| `InputModalities` | `*string` | :heavy_minus_sign: | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | +| `Context` | `*int64` | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | +| `MinPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum prompt price in $/M tokens. | 0 | +| `MaxPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum prompt price in $/M tokens. | 10 | +| `Arch` | `*string` | :heavy_minus_sign: | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | +| `ModelAuthors` | `*string` | :heavy_minus_sign: | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | +| `Providers` | `*string` | :heavy_minus_sign: | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | +| `Distillable` | [*operations.Distillable](../../models/operations/distillable.mdx) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `Zdr` | [*operations.Zdr](../../models/operations/zdr.mdx) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | +| `Region` | [*operations.Region](../../models/operations/region.mdx) | :heavy_minus_sign: | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | +| `MinOutputPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | +| `MaxOutputPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | +| `MinAgeDays` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | +| `MaxAgeDays` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum model age in days since its creation date. | 90 | +| `MinIntelligenceIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum Artificial Analysis intelligence index. | 50 | +| `MaxIntelligenceIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum Artificial Analysis intelligence index. | 100 | +| `MinCodingIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum Artificial Analysis coding index. | 50 | +| `MaxCodingIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum Artificial Analysis coding index. | 100 | +| `MinAgenticIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum Artificial Analysis agentic index. | 50 | +| `MaxAgenticIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum Artificial Analysis agentic index. | 100 | +| `MinToolSuccessRate` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). | 0.9 | +| `MaxToolSuccessRate` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file diff --git a/docs/models/operations/getmodelsresponse.mdx b/docs/models/operations/getmodelsresponse.mdx index 8c224f892..dc7254dd0 100644 --- a/docs/models/operations/getmodelsresponse.mdx +++ b/docs/models/operations/getmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "GetModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/getobservabilitydestinationrequest.mdx b/docs/models/operations/getobservabilitydestinationrequest.mdx index 266e0c718..1b7ebf195 100644 --- a/docs/models/operations/getobservabilitydestinationrequest.mdx +++ b/docs/models/operations/getobservabilitydestinationrequest.mdx @@ -6,4 +6,4 @@ title: "GetObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/models/operations/getorganizationsettingsresponse.mdx b/docs/models/operations/getorganizationsettingsresponse.mdx index 033b2a96f..e432f771c 100644 --- a/docs/models/operations/getorganizationsettingsresponse.mdx +++ b/docs/models/operations/getorganizationsettingsresponse.mdx @@ -9,4 +9,4 @@ Organization settings | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.OrganizationSettings](../../models/components/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file +| `Data` | [components.OrganizationSettings](../../models/components/organizationsettings.mdx) | :heavy_check_mark: | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file diff --git a/docs/models/operations/getpresetrequest.mdx b/docs/models/operations/getpresetrequest.mdx index d214c7a32..c24f183c9 100644 --- a/docs/models/operations/getpresetrequest.mdx +++ b/docs/models/operations/getpresetrequest.mdx @@ -6,4 +6,4 @@ title: "GetPresetRequest" | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file +| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file diff --git a/docs/models/operations/getpresetversionrequest.mdx b/docs/models/operations/getpresetversionrequest.mdx index 3733c88a0..519f31f1d 100644 --- a/docs/models/operations/getpresetversionrequest.mdx +++ b/docs/models/operations/getpresetversionrequest.mdx @@ -6,5 +6,5 @@ title: "GetPresetVersionRequest" | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | -| `Version` | `string` | ✅ | Version number of the preset. | 1 | \ No newline at end of file +| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `Version` | `string` | :heavy_check_mark: | Version number of the preset. | 1 | \ No newline at end of file diff --git a/docs/models/operations/getprivateendpointrequest.mdx b/docs/models/operations/getprivateendpointrequest.mdx index e7b82f35b..bcc6ebac6 100644 --- a/docs/models/operations/getprivateendpointrequest.mdx +++ b/docs/models/operations/getprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "GetPrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/getrankingsdailyrequest.mdx b/docs/models/operations/getrankingsdailyrequest.mdx index b11f0134b..45ad08830 100644 --- a/docs/models/operations/getrankingsdailyrequest.mdx +++ b/docs/models/operations/getrankingsdailyrequest.mdx @@ -6,10 +6,10 @@ title: "GetRankingsDailyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `StartDate` | `*string` | ➖ | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | -| `EndDate` | `*string` | ➖ | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | -| `Period` | [*operations.Period](../../models/operations/period.mdx) | ➖ | Time grain of each row. `day` (default) returns the per-UTC-day series; `week` buckets by ISO week start; `month` buckets by month start. With `category` or `language_type` only `week` (default) and `month` are available — `day` is rejected with a 400 because those datasets are aggregated weekly. For those sampled datasets `period=month` buckets each week by its week-start month, so totals are approximate at month boundaries. | day | -| `Modality` | [*operations.Modality](../../models/operations/modality.mdx) | ➖ | Restrict to models for a modality surface: `text` / `image_output` match output modality, `image` / `audio` match input modality, and `tool_calling` keeps only rows that recorded at least one tool call. Exact dataset — cannot be combined with `category` or `language_type`. | text | -| `ContextBucket` | [*operations.ContextBucket](../../models/operations/contextbucket.mdx) | ➖ | Restrict to requests whose context length falls in this bucket (`1K`, `10K`, `100K`, `1M`, or `10M`). Exact dataset — cannot be combined with `category` or `language_type`. | 100K | -| `Category` | [*operations.GetRankingsDailyCategory](../../models/operations/getrankingsdailycategory.mdx) | ➖ | Restrict to a use-case category (e.g. `programming`, `roleplay`). Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `language_type`. | programming | -| `LanguageType` | [*operations.LanguageType](../../models/operations/languagetype.mdx) | ➖ | Restrict to natural-language or programming-language tagged activity. Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `category`. | natural | \ No newline at end of file +| `StartDate` | `*string` | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | +| `EndDate` | `*string` | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | +| `Period` | [*operations.Period](../../models/operations/period.mdx) | :heavy_minus_sign: | Time grain of each row. `day` (default) returns the per-UTC-day series; `week` buckets by ISO week start; `month` buckets by month start. With `category` or `language_type` only `week` (default) and `month` are available — `day` is rejected with a 400 because those datasets are aggregated weekly. For those sampled datasets `period=month` buckets each week by its week-start month, so totals are approximate at month boundaries. | day | +| `Modality` | [*operations.Modality](../../models/operations/modality.mdx) | :heavy_minus_sign: | Restrict to models for a modality surface: `text` / `image_output` match output modality, `image` / `audio` match input modality, and `tool_calling` keeps only rows that recorded at least one tool call. Exact dataset — cannot be combined with `category` or `language_type`. | text | +| `ContextBucket` | [*operations.ContextBucket](../../models/operations/contextbucket.mdx) | :heavy_minus_sign: | Restrict to requests whose context length falls in this bucket (`1K`, `10K`, `100K`, `1M`, or `10M`). Exact dataset — cannot be combined with `category` or `language_type`. | 100K | +| `Category` | [*operations.GetRankingsDailyCategory](../../models/operations/getrankingsdailycategory.mdx) | :heavy_minus_sign: | Restrict to a use-case category (e.g. `programming`, `roleplay`). Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `language_type`. | programming | +| `LanguageType` | [*operations.LanguageType](../../models/operations/languagetype.mdx) | :heavy_minus_sign: | Restrict to natural-language or programming-language tagged activity. Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `category`. | natural | \ No newline at end of file diff --git a/docs/models/operations/getscimgroupmappingrequest.mdx b/docs/models/operations/getscimgroupmappingrequest.mdx index bc7b15c70..6efec4dd2 100644 --- a/docs/models/operations/getscimgroupmappingrequest.mdx +++ b/docs/models/operations/getscimgroupmappingrequest.mdx @@ -6,4 +6,4 @@ title: "GetScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | ✅ | N/A | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getscimsyncjobrequest.mdx b/docs/models/operations/getscimsyncjobrequest.mdx index 91b97e4a9..6a2de6f63 100644 --- a/docs/models/operations/getscimsyncjobrequest.mdx +++ b/docs/models/operations/getscimsyncjobrequest.mdx @@ -6,4 +6,4 @@ title: "GetScimSyncJobRequest" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | ✅ | N/A | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getsessioncostrequest.mdx b/docs/models/operations/getsessioncostrequest.mdx index 7730c906b..1a3b5e044 100644 --- a/docs/models/operations/getsessioncostrequest.mdx +++ b/docs/models/operations/getsessioncostrequest.mdx @@ -6,8 +6,8 @@ title: "GetSessionCostRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `AppSlug` | `*string` | ➖ | Filter to one published harness slug. | hermes-agent | -| `Model` | `*string` | ➖ | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | -| `TurnRange` | [*operations.TurnRange](../../models/operations/turnrange.mdx) | ➖ | Filter by the inclusive number of turns in a session. | 10-49-turns | -| `Limit` | `*int64` | ➖ | Maximum number of cells to return (1-500). Defaults to 100. | 100 | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file +| `AppSlug` | `*string` | :heavy_minus_sign: | Filter to one published harness slug. | hermes-agent | +| `Model` | `*string` | :heavy_minus_sign: | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | +| `TurnRange` | [*operations.TurnRange](../../models/operations/turnrange.mdx) | :heavy_minus_sign: | Filter by the inclusive number of turns in a session. | 10-49-turns | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of cells to return (1-500). Defaults to 100. | 100 | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/getsessioncostresponse.mdx b/docs/models/operations/getsessioncostresponse.mdx index b95ccae59..c319e4565 100644 --- a/docs/models/operations/getsessioncostresponse.mdx +++ b/docs/models/operations/getsessioncostresponse.mdx @@ -6,4 +6,4 @@ title: "GetSessionCostResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Result` | [components.SessionCostResponse](../../models/components/sessioncostresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `Result` | [components.SessionCostResponse](../../models/components/sessioncostresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/gettaskclassificationsrequest.mdx b/docs/models/operations/gettaskclassificationsrequest.mdx index ca08656c2..a80174e69 100644 --- a/docs/models/operations/gettaskclassificationsrequest.mdx +++ b/docs/models/operations/gettaskclassificationsrequest.mdx @@ -6,4 +6,4 @@ title: "GetTaskClassificationsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Window` | [*operations.Window](../../models/operations/window.mdx) | ➖ | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | \ No newline at end of file +| `Window` | [*operations.Window](../../models/operations/window.mdx) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | \ No newline at end of file diff --git a/docs/models/operations/gettoolrequest.mdx b/docs/models/operations/gettoolrequest.mdx index 9daab90a4..3fafe4f61 100644 --- a/docs/models/operations/gettoolrequest.mdx +++ b/docs/models/operations/gettoolrequest.mdx @@ -6,4 +6,4 @@ title: "GetToolRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Name` | `string` | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file diff --git a/docs/models/operations/gettoolresponse.mdx b/docs/models/operations/gettoolresponse.mdx index 605a89853..1fa45c0b5 100644 --- a/docs/models/operations/gettoolresponse.mdx +++ b/docs/models/operations/gettoolresponse.mdx @@ -6,5 +6,5 @@ title: "GetToolResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | ✅ | N/A | -| `Result` | [*components.GetToolResponse](../../models/components/gettoolresponse.mdx) | ➖ | N/A | \ No newline at end of file +| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | +| `Result` | [*components.GetToolResponse](../../models/components/gettoolresponse.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/gettoolsecurity.mdx b/docs/models/operations/gettoolsecurity.mdx index 56f9fe66a..95a591f90 100644 --- a/docs/models/operations/gettoolsecurity.mdx +++ b/docs/models/operations/gettoolsecurity.mdx @@ -6,4 +6,4 @@ title: "GetToolSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bearer` | `string` | ✅ | N/A | \ No newline at end of file +| `Bearer` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getuseractivityrequest.mdx b/docs/models/operations/getuseractivityrequest.mdx index 144953a56..08fa27a64 100644 --- a/docs/models/operations/getuseractivityrequest.mdx +++ b/docs/models/operations/getuseractivityrequest.mdx @@ -6,8 +6,8 @@ title: "GetUserActivityRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Date` | `*string` | ➖ | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `APIKeyHash` | `*string` | ➖ | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `UserID` | `*string` | ➖ | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | -| `GroupBy` | [*operations.GroupBy](../../models/operations/groupby.mdx) | ➖ | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | -| `WorkspaceID` | `*string` | ➖ | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `Date` | `*string` | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | +| `APIKeyHash` | `*string` | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | +| `UserID` | `*string` | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | +| `GroupBy` | [*operations.GroupBy](../../models/operations/groupby.mdx) | :heavy_minus_sign: | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/getvideosrequest.mdx b/docs/models/operations/getvideosrequest.mdx index c7c6cb8e7..195169bbe 100644 --- a/docs/models/operations/getvideosrequest.mdx +++ b/docs/models/operations/getvideosrequest.mdx @@ -6,4 +6,4 @@ title: "GetVideosRequest" | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `JobID` | `string` | ✅ | N/A | job-abc123 | \ No newline at end of file +| `JobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | \ No newline at end of file diff --git a/docs/models/operations/getworkspacebudgetrequest.mdx b/docs/models/operations/getworkspacebudgetrequest.mdx index 3d6766acc..f9c1bade8 100644 --- a/docs/models/operations/getworkspacebudgetrequest.mdx +++ b/docs/models/operations/getworkspacebudgetrequest.mdx @@ -6,5 +6,5 @@ title: "GetWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `WorkspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file +| `WorkspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file diff --git a/docs/models/operations/getworkspacerequest.mdx b/docs/models/operations/getworkspacerequest.mdx index 6deaba1d4..f55c4a768 100644 --- a/docs/models/operations/getworkspacerequest.mdx +++ b/docs/models/operations/getworkspacerequest.mdx @@ -6,4 +6,4 @@ title: "GetWorkspaceRequest" | Field | Type | Required | Description | Example | | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/models/operations/granularity.mdx b/docs/models/operations/granularity.mdx index 3f84c2969..e63f71fac 100644 --- a/docs/models/operations/granularity.mdx +++ b/docs/models/operations/granularity.mdx @@ -6,5 +6,5 @@ title: "Granularity" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `DisplayLabel` | `string` | ✅ | Human-readable label | Day | -| `Name` | [operations.GranularityName](../../models/operations/granularityname.mdx) | ✅ | Granularity identifier | day | \ No newline at end of file +| `DisplayLabel` | `string` | :heavy_check_mark: | Human-readable label | Day | +| `Name` | [operations.GranularityName](../../models/operations/granularityname.mdx) | :heavy_check_mark: | Granularity identifier | day | \ No newline at end of file diff --git a/docs/models/operations/imageurl.mdx b/docs/models/operations/imageurl.mdx index 791103a25..5503dd2ce 100644 --- a/docs/models/operations/imageurl.mdx +++ b/docs/models/operations/imageurl.mdx @@ -6,4 +6,4 @@ title: "ImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | ✅ | N/A | \ No newline at end of file +| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/input.mdx b/docs/models/operations/input.mdx index 46f907ef1..560e8b396 100644 --- a/docs/models/operations/input.mdx +++ b/docs/models/operations/input.mdx @@ -6,4 +6,4 @@ title: "Input" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Content` | [][operations.Content](../../models/operations/content.mdx) | ✅ | N/A | \ No newline at end of file +| `Content` | [][operations.Content](../../models/operations/content.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/invokeinternrequest.mdx b/docs/models/operations/invokeinternrequest.mdx index 3d514eb07..809d031dd 100644 --- a/docs/models/operations/invokeinternrequest.mdx +++ b/docs/models/operations/invokeinternrequest.mdx @@ -6,5 +6,5 @@ title: "InvokeInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `InternID` | `string` | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `InternInvokeRequest` | [components.InternInvokeRequest](../../models/components/interninvokerequest.mdx) | ✅ | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `InternInvokeRequest` | [components.InternInvokeRequest](../../models/components/interninvokerequest.mdx) | :heavy_check_mark: | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | \ No newline at end of file diff --git a/docs/models/operations/invokeinternresponse.mdx b/docs/models/operations/invokeinternresponse.mdx index c740f088b..0d577fbd9 100644 --- a/docs/models/operations/invokeinternresponse.mdx +++ b/docs/models/operations/invokeinternresponse.mdx @@ -6,5 +6,5 @@ title: "InvokeInternResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | ✅ | N/A | | -| `Result` | [components.InternInvokeAcceptedResponse](../../models/components/interninvokeacceptedresponse.mdx) | ✅ | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file +| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | | +| `Result` | [components.InternInvokeAcceptedResponse](../../models/components/interninvokeacceptedresponse.mdx) | :heavy_check_mark: | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file diff --git a/docs/models/operations/listbatchesrequest.mdx b/docs/models/operations/listbatchesrequest.mdx index 9e4e7f371..c5ac6fd04 100644 --- a/docs/models/operations/listbatchesrequest.mdx +++ b/docs/models/operations/listbatchesrequest.mdx @@ -6,8 +6,8 @@ title: "ListBatchesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `Limit` | `*int64` | ➖ | Maximum number of batches to return, from 1 through 100. | 20 | -| `After` | `*string` | ➖ | Batch id from the previous page's `last_id`. | batch_7a4b02 | -| `Status` | [][components.BatchListStatus](../../models/components/batchliststatus.mdx) | ➖ | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | -| `CreatedAfter` | [*components.BatchListTimestamp](../../models/components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | -| `CreatedBefore` | [*components.BatchListTimestamp](../../models/components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | \ No newline at end of file +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of batches to return, from 1 through 100. | 20 | +| `After` | `*string` | :heavy_minus_sign: | Batch id from the previous page's `last_id`. | batch_7a4b02 | +| `Status` | [][components.BatchListStatus](../../models/components/batchliststatus.mdx) | :heavy_minus_sign: | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | +| `CreatedAfter` | [*components.BatchListTimestamp](../../models/components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | +| `CreatedBefore` | [*components.BatchListTimestamp](../../models/components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | \ No newline at end of file diff --git a/docs/models/operations/listbatchesresponse.mdx b/docs/models/operations/listbatchesresponse.mdx index 2c89581f1..a8d828c07 100644 --- a/docs/models/operations/listbatchesresponse.mdx +++ b/docs/models/operations/listbatchesresponse.mdx @@ -6,4 +6,4 @@ title: "ListBatchesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Result` | [components.BatchListResponse](../../models/components/batchlistresponse.mdx) | ✅ | N/A | \{
"data": [],
"first_id": null,
"has_more": false,
"last_id": null,
"object": "list"
} | \ No newline at end of file +| `Result` | [components.BatchListResponse](../../models/components/batchlistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [],
"first_id": null,
"has_more": false,
"last_id": null,
"object": "list"
} | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysrequest.mdx b/docs/models/operations/listbyokkeysrequest.mdx index f9fe882db..66b2ffa3e 100644 --- a/docs/models/operations/listbyokkeysrequest.mdx +++ b/docs/models/operations/listbyokkeysrequest.mdx @@ -6,7 +6,7 @@ title: "ListBYOKKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `WorkspaceID` | `*string` | ➖ | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | -| `Provider` | [*operations.Provider](../../models/operations/provider.mdx) | ➖ | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | +| `Provider` | [*operations.Provider](../../models/operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysresponse.mdx b/docs/models/operations/listbyokkeysresponse.mdx index e566fd1c9..8cdcc228f 100644 --- a/docs/models/operations/listbyokkeysresponse.mdx +++ b/docs/models/operations/listbyokkeysresponse.mdx @@ -6,4 +6,4 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.ListBYOKKeysResponse](../../models/components/listbyokkeysresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListBYOKKeysResponse](../../models/components/listbyokkeysresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listcontainerfilesrequest.mdx b/docs/models/operations/listcontainerfilesrequest.mdx index ecfa78cb0..3074faa6b 100644 --- a/docs/models/operations/listcontainerfilesrequest.mdx +++ b/docs/models/operations/listcontainerfilesrequest.mdx @@ -6,6 +6,6 @@ title: "ListContainerFilesRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `Limit` | `*int64` | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `After` | `*string` | ➖ | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `After` | `*string` | :heavy_minus_sign: | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/listdata.mdx b/docs/models/operations/listdata.mdx index 8d00f1f4b..ba0704639 100644 --- a/docs/models/operations/listdata.mdx +++ b/docs/models/operations/listdata.mdx @@ -6,26 +6,26 @@ title: "ListData" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | ✅ | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `ExternalUser` | `*string` | ✅ | Partner's end-user identifier used for attribution. | null | -| `Hash` | `string` | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | -| `Name` | `string` | ✅ | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `ExternalUser` | `*string` | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | +| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | +| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listembeddingsmodelsrequest.mdx b/docs/models/operations/listembeddingsmodelsrequest.mdx index a76440dfb..98242d430 100644 --- a/docs/models/operations/listembeddingsmodelsrequest.mdx +++ b/docs/models/operations/listembeddingsmodelsrequest.mdx @@ -6,5 +6,5 @@ title: "ListEmbeddingsModelsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | \ No newline at end of file diff --git a/docs/models/operations/listembeddingsmodelsresponse.mdx b/docs/models/operations/listembeddingsmodelsresponse.mdx index c033d393f..2512a3f51 100644 --- a/docs/models/operations/listembeddingsmodelsresponse.mdx +++ b/docs/models/operations/listembeddingsmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "ListEmbeddingsModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/listendpointsrequest.mdx b/docs/models/operations/listendpointsrequest.mdx index 54fa8fdbd..5addbc78d 100644 --- a/docs/models/operations/listendpointsrequest.mdx +++ b/docs/models/operations/listendpointsrequest.mdx @@ -6,5 +6,5 @@ title: "ListEndpointsRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `Author` | `string` | ✅ | The author/organization of the model | openai | -| `Slug` | `string` | ✅ | The model slug | gpt-4 | \ No newline at end of file +| `Author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | +| `Slug` | `string` | :heavy_check_mark: | The model slug | gpt-4 | \ No newline at end of file diff --git a/docs/models/operations/listendpointsresponse.mdx b/docs/models/operations/listendpointsresponse.mdx index c7fc9a806..8f62ed5fb 100644 --- a/docs/models/operations/listendpointsresponse.mdx +++ b/docs/models/operations/listendpointsresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.ListEndpointsResponse](../../models/components/listendpointsresponse.mdx) | ✅ | List of available endpoints for a model | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"created": 1692901234,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"endpoints": [
\{
"context_length": 8192,
"latency_last_30m": \{
"p50": 0.25,
"p75": 0.35,
"p90": 0.48,
"p99": 0.85
},
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"model_id": "openai/gpt-4",
"model_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"provider_name": "OpenAI",
"quantization": "fp16",
"status": 0,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supports_implicit_caching": true,
"tag": "openai",
"throughput_last_30m": \{
"p50": 45.2,
"p75": 38.5,
"p90": 28.3,
"p99": 15.1
},
"uptime_last_1d": 99.8,
"uptime_last_30m": 99.5,
"uptime_last_5m": 100
}
],
"id": "openai/gpt-4",
"name": "GPT-4"
} | \ No newline at end of file +| `Data` | [components.ListEndpointsResponse](../../models/components/listendpointsresponse.mdx) | :heavy_check_mark: | List of available endpoints for a model | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"created": 1692901234,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"endpoints": [
\{
"context_length": 8192,
"latency_last_30m": \{
"p50": 0.25,
"p75": 0.35,
"p90": 0.48,
"p99": 0.85
},
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"model_id": "openai/gpt-4",
"model_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"provider_name": "OpenAI",
"quantization": "fp16",
"status": 0,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supports_implicit_caching": true,
"tag": "openai",
"throughput_last_30m": \{
"p50": 45.2,
"p75": 38.5,
"p90": 28.3,
"p99": 15.1
},
"uptime_last_1d": 99.8,
"uptime_last_30m": 99.5,
"uptime_last_5m": 100
}
],
"id": "openai/gpt-4",
"name": "GPT-4"
} | \ No newline at end of file diff --git a/docs/models/operations/listendpointszdrresponse.mdx b/docs/models/operations/listendpointszdrresponse.mdx index 101eb01be..3aed99b5d 100644 --- a/docs/models/operations/listendpointszdrresponse.mdx +++ b/docs/models/operations/listendpointszdrresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Data` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listendusersrequest.mdx b/docs/models/operations/listendusersrequest.mdx index d92582eaf..7ea3dac06 100644 --- a/docs/models/operations/listendusersrequest.mdx +++ b/docs/models/operations/listendusersrequest.mdx @@ -4,9 +4,9 @@ title: "ListEndUsersRequest" ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `User` | `*string` | ➖ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | -| `IncludeInactive` | `*bool` | ➖ | Include deactivated registrations. | false | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `User` | `*string` | :heavy_minus_sign: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `IncludeInactive` | `*bool` | :heavy_minus_sign: | Include deactivated registrations. | false | \ No newline at end of file diff --git a/docs/models/operations/listendusersresponse.mdx b/docs/models/operations/listendusersresponse.mdx index a7e70f9e9..44323704d 100644 --- a/docs/models/operations/listendusersresponse.mdx +++ b/docs/models/operations/listendusersresponse.mdx @@ -6,4 +6,4 @@ title: "ListEndUsersResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListEndUsersResponse](../../models/components/listendusersresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListEndUsersResponse](../../models/components/listendusersresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listfilesrequest.mdx b/docs/models/operations/listfilesrequest.mdx index d7b639027..b4ae6e399 100644 --- a/docs/models/operations/listfilesrequest.mdx +++ b/docs/models/operations/listfilesrequest.mdx @@ -6,11 +6,11 @@ title: "ListFilesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Limit` | `*int64` | ➖ | Maximum number of files to return (1–1000). | 100 | -| `Cursor` | `*string` | ➖ | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | -| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `After` | `*string` | ➖ | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `AfterID` | `*string` | ➖ | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `BeforeID` | `*string` | ➖ | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `Order` | [*operations.Order](../../models/operations/order.mdx) | ➖ | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of files to return (1–1000). | 100 | +| `Cursor` | `*string` | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `After` | `*string` | :heavy_minus_sign: | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `AfterID` | `*string` | :heavy_minus_sign: | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `BeforeID` | `*string` | :heavy_minus_sign: | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `Order` | [*operations.Order](../../models/operations/order.mdx) | :heavy_minus_sign: | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file diff --git a/docs/models/operations/listfilesresponse.mdx b/docs/models/operations/listfilesresponse.mdx index 46d09bb4d..eae01171a 100644 --- a/docs/models/operations/listfilesresponse.mdx +++ b/docs/models/operations/listfilesresponse.mdx @@ -6,4 +6,4 @@ title: "ListFilesResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.FileListResponse](../../models/components/filelistresponse.mdx) | ✅ | N/A | \{
"_shape": "openrouter",
"cursor": null,
"data": [],
"first_id": null,
"has_more": false,
"last_id": null
} | \ No newline at end of file +| `Result` | [components.FileListResponse](../../models/components/filelistresponse.mdx) | :heavy_check_mark: | N/A | \{
"_shape": "openrouter",
"cursor": null,
"data": [],
"first_id": null,
"has_more": false,
"last_id": null
} | \ No newline at end of file diff --git a/docs/models/operations/listgenerationcontentrequest.mdx b/docs/models/operations/listgenerationcontentrequest.mdx index 16c99e27d..8ea15cc26 100644 --- a/docs/models/operations/listgenerationcontentrequest.mdx +++ b/docs/models/operations/listgenerationcontentrequest.mdx @@ -6,4 +6,4 @@ title: "ListGenerationContentRequest" | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailkeyassignmentsrequest.mdx b/docs/models/operations/listguardrailkeyassignmentsrequest.mdx index 54a9449db..f6c4df2bf 100644 --- a/docs/models/operations/listguardrailkeyassignmentsrequest.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsrequest.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailKeyAssignmentsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx index 9c45755a1..b1a2c2e2c 100644 --- a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listguardrailmemberassignmentsrequest.mdx b/docs/models/operations/listguardrailmemberassignmentsrequest.mdx index d3b7037a1..3af73135c 100644 --- a/docs/models/operations/listguardrailmemberassignmentsrequest.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsrequest.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailMemberAssignmentsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx index 1d584934d..ee830a1c2 100644 --- a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listguardrailsrequest.mdx b/docs/models/operations/listguardrailsrequest.mdx index cfe6be5ac..260892889 100644 --- a/docs/models/operations/listguardrailsrequest.mdx +++ b/docs/models/operations/listguardrailsrequest.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `WorkspaceID` | `*string` | ➖ | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailsresponse.mdx b/docs/models/operations/listguardrailsresponse.mdx index 8b4bae811..67526da8e 100644 --- a/docs/models/operations/listguardrailsresponse.mdx +++ b/docs/models/operations/listguardrailsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListGuardrailsResponse](../../models/components/listguardrailsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListGuardrailsResponse](../../models/components/listguardrailsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listimagemodelendpointsrequest.mdx b/docs/models/operations/listimagemodelendpointsrequest.mdx index 2f596beb0..c83a428b0 100644 --- a/docs/models/operations/listimagemodelendpointsrequest.mdx +++ b/docs/models/operations/listimagemodelendpointsrequest.mdx @@ -6,5 +6,5 @@ title: "ListImageModelEndpointsRequest" | Field | Type | Required | Description | Example | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `Author` | `string` | ✅ | Model author/organization | bytedance-seed | -| `Slug` | `string` | ✅ | Model slug | seedream-4.5 | \ No newline at end of file +| `Author` | `string` | :heavy_check_mark: | Model author/organization | bytedance-seed | +| `Slug` | `string` | :heavy_check_mark: | Model slug | seedream-4.5 | \ No newline at end of file diff --git a/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx b/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx index 78df22a14..aa12d39dd 100644 --- a/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx +++ b/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx @@ -6,6 +6,6 @@ title: "ListInternEffectiveVaultSecretsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `Limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `Offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `Limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `Offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listinternsrequest.mdx b/docs/models/operations/listinternsrequest.mdx index cb28ac484..ec14bfd77 100644 --- a/docs/models/operations/listinternsrequest.mdx +++ b/docs/models/operations/listinternsrequest.mdx @@ -6,7 +6,7 @@ title: "ListInternsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `Limit` | `*int64` | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | -| `Status` | [][operations.Status](../../models/operations/status.mdx) | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `StartingAfter` | `*string` | ➖ | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | -| `WorkspaceID` | `*string` | ➖ | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | \ No newline at end of file +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | +| `Status` | [][operations.Status](../../models/operations/status.mdx) | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `StartingAfter` | `*string` | :heavy_minus_sign: | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | \ No newline at end of file diff --git a/docs/models/operations/listinternvaultsecretsrequest.mdx b/docs/models/operations/listinternvaultsecretsrequest.mdx index 435fe5edb..370d6f143 100644 --- a/docs/models/operations/listinternvaultsecretsrequest.mdx +++ b/docs/models/operations/listinternvaultsecretsrequest.mdx @@ -6,6 +6,6 @@ title: "ListInternVaultSecretsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `Limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `Offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `Limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `Offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listkeyassignmentsrequest.mdx b/docs/models/operations/listkeyassignmentsrequest.mdx index 6b7e92afb..325a6b5de 100644 --- a/docs/models/operations/listkeyassignmentsrequest.mdx +++ b/docs/models/operations/listkeyassignmentsrequest.mdx @@ -6,5 +6,5 @@ title: "ListKeyAssignmentsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listkeyassignmentsresponse.mdx b/docs/models/operations/listkeyassignmentsresponse.mdx index 3b73c0222..02bce345f 100644 --- a/docs/models/operations/listkeyassignmentsresponse.mdx +++ b/docs/models/operations/listkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listmemberassignmentsrequest.mdx b/docs/models/operations/listmemberassignmentsrequest.mdx index b05cc99a5..ac8f63c94 100644 --- a/docs/models/operations/listmemberassignmentsrequest.mdx +++ b/docs/models/operations/listmemberassignmentsrequest.mdx @@ -6,5 +6,5 @@ title: "ListMemberAssignmentsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listmemberassignmentsresponse.mdx b/docs/models/operations/listmemberassignmentsresponse.mdx index da1412e0e..f1ab24007 100644 --- a/docs/models/operations/listmemberassignmentsresponse.mdx +++ b/docs/models/operations/listmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listmodelscountrequest.mdx b/docs/models/operations/listmodelscountrequest.mdx index dfd5dd9f0..9cc8b943a 100644 --- a/docs/models/operations/listmodelscountrequest.mdx +++ b/docs/models/operations/listmodelscountrequest.mdx @@ -6,4 +6,4 @@ title: "ListModelsCountRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `OutputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file +| `OutputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file diff --git a/docs/models/operations/listmodelsuserrequest.mdx b/docs/models/operations/listmodelsuserrequest.mdx index e25cc0ef6..b992b6990 100644 --- a/docs/models/operations/listmodelsuserrequest.mdx +++ b/docs/models/operations/listmodelsuserrequest.mdx @@ -6,6 +6,6 @@ title: "ListModelsUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `OutputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `OutputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file diff --git a/docs/models/operations/listmodelsuserresponse.mdx b/docs/models/operations/listmodelsuserresponse.mdx index 1a83c42b7..2efd1749a 100644 --- a/docs/models/operations/listmodelsuserresponse.mdx +++ b/docs/models/operations/listmodelsuserresponse.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/listmodelsusersecurity.mdx b/docs/models/operations/listmodelsusersecurity.mdx index dd5872669..3f2892bf6 100644 --- a/docs/models/operations/listmodelsusersecurity.mdx +++ b/docs/models/operations/listmodelsusersecurity.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bearer` | `string` | ✅ | N/A | \ No newline at end of file +| `Bearer` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listobservabilitydestinationsrequest.mdx b/docs/models/operations/listobservabilitydestinationsrequest.mdx index 194c98c2d..9fef8bdc7 100644 --- a/docs/models/operations/listobservabilitydestinationsrequest.mdx +++ b/docs/models/operations/listobservabilitydestinationsrequest.mdx @@ -6,6 +6,6 @@ title: "ListObservabilityDestinationsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `WorkspaceID` | `*string` | ➖ | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/listobservabilitydestinationsresponse.mdx b/docs/models/operations/listobservabilitydestinationsresponse.mdx index 7c987d73d..48fcf78c5 100644 --- a/docs/models/operations/listobservabilitydestinationsresponse.mdx +++ b/docs/models/operations/listobservabilitydestinationsresponse.mdx @@ -6,4 +6,4 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListObservabilityDestinationsResponse](../../models/components/listobservabilitydestinationsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListObservabilityDestinationsResponse](../../models/components/listobservabilitydestinationsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersdata.mdx b/docs/models/operations/listorganizationmembersdata.mdx index f58de7cd3..9f22477b5 100644 --- a/docs/models/operations/listorganizationmembersdata.mdx +++ b/docs/models/operations/listorganizationmembersdata.mdx @@ -6,8 +6,8 @@ title: "ListOrganizationMembersData" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Email` | `string` | ✅ | Email address of the member | jane.doe@example.com | -| `FirstName` | `*string` | ✅ | First name of the member | Jane | -| `ID` | `string` | ✅ | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | -| `LastName` | `*string` | ✅ | Last name of the member | Doe | -| `Role` | [operations.Role](../../models/operations/role.mdx) | ✅ | Role of the member in the organization | org:member | \ No newline at end of file +| `Email` | `string` | :heavy_check_mark: | Email address of the member | jane.doe@example.com | +| `FirstName` | `*string` | :heavy_check_mark: | First name of the member | Jane | +| `ID` | `string` | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | +| `LastName` | `*string` | :heavy_check_mark: | Last name of the member | Doe | +| `Role` | [operations.Role](../../models/operations/role.mdx) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersrequest.mdx b/docs/models/operations/listorganizationmembersrequest.mdx index 664147d31..672155084 100644 --- a/docs/models/operations/listorganizationmembersrequest.mdx +++ b/docs/models/operations/listorganizationmembersrequest.mdx @@ -6,5 +6,5 @@ title: "ListOrganizationMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponse.mdx b/docs/models/operations/listorganizationmembersresponse.mdx index f282b6608..0dd53b741 100644 --- a/docs/models/operations/listorganizationmembersresponse.mdx +++ b/docs/models/operations/listorganizationmembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListOrganizationMembersResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Result` | [operations.ListOrganizationMembersResponseBody](../../models/operations/listorganizationmembersresponsebody.mdx) | ✅ | N/A | \ No newline at end of file +| `Result` | [operations.ListOrganizationMembersResponseBody](../../models/operations/listorganizationmembersresponsebody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponsebody.mdx b/docs/models/operations/listorganizationmembersresponsebody.mdx index ca3696304..89160146d 100644 --- a/docs/models/operations/listorganizationmembersresponsebody.mdx +++ b/docs/models/operations/listorganizationmembersresponsebody.mdx @@ -9,5 +9,5 @@ List of organization members | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Data` | [][operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata.mdx) | ✅ | List of organization members | | -| `TotalCount` | `int64` | ✅ | Total number of members in the organization | 25 | \ No newline at end of file +| `Data` | [][operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata.mdx) | :heavy_check_mark: | List of organization members | | +| `TotalCount` | `int64` | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/docs/models/operations/listpresetsrequest.mdx b/docs/models/operations/listpresetsrequest.mdx index fd403ef08..68006e47c 100644 --- a/docs/models/operations/listpresetsrequest.mdx +++ b/docs/models/operations/listpresetsrequest.mdx @@ -6,5 +6,5 @@ title: "ListPresetsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listpresetsresponse.mdx b/docs/models/operations/listpresetsresponse.mdx index 2ee844986..b2f448b8b 100644 --- a/docs/models/operations/listpresetsresponse.mdx +++ b/docs/models/operations/listpresetsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.ListPresetsResponse](../../models/components/listpresetsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListPresetsResponse](../../models/components/listpresetsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listpresetversionsrequest.mdx b/docs/models/operations/listpresetversionsrequest.mdx index 69dec98bb..b87256d7c 100644 --- a/docs/models/operations/listpresetversionsrequest.mdx +++ b/docs/models/operations/listpresetversionsrequest.mdx @@ -6,6 +6,6 @@ title: "ListPresetVersionsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listpresetversionsresponse.mdx b/docs/models/operations/listpresetversionsresponse.mdx index 6fdd0c2a4..1e9724a33 100644 --- a/docs/models/operations/listpresetversionsresponse.mdx +++ b/docs/models/operations/listpresetversionsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetVersionsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.ListPresetVersionsResponse](../../models/components/listpresetversionsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListPresetVersionsResponse](../../models/components/listpresetversionsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listprovidersdata.mdx b/docs/models/operations/listprovidersdata.mdx index f1695d299..d3a2945a0 100644 --- a/docs/models/operations/listprovidersdata.mdx +++ b/docs/models/operations/listprovidersdata.mdx @@ -6,10 +6,10 @@ title: "ListProvidersData" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Datacenters` | optionalnullable.OptionalNullable[[][operations.Datacenter](../../models/operations/datacenter.mdx)] | ➖ | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `Headquarters` | optionalnullable.OptionalNullable[[operations.Headquarters](../../models/operations/headquarters.mdx)] | ➖ | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | -| `Name` | `string` | ✅ | Display name of the provider | OpenAI | -| `PrivacyPolicyURL` | `*string` | ✅ | URL to the provider's privacy policy | https://openai.com/privacy | -| `Slug` | `string` | ✅ | URL-friendly identifier for the provider | openai | -| `StatusPageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | URL to the provider's status page | https://status.openai.com | -| `TermsOfServiceURL` | optionalnullable.OptionalNullable[`string`] | ➖ | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file +| `Datacenters` | optionalnullable.OptionalNullable[[][operations.Datacenter](../../models/operations/datacenter.mdx)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | +| `Headquarters` | optionalnullable.OptionalNullable[[operations.Headquarters](../../models/operations/headquarters.mdx)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | +| `Name` | `string` | :heavy_check_mark: | Display name of the provider | OpenAI | +| `PrivacyPolicyURL` | `*string` | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | +| `Slug` | `string` | :heavy_check_mark: | URL-friendly identifier for the provider | openai | +| `StatusPageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | +| `TermsOfServiceURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file diff --git a/docs/models/operations/listprovidersresponse.mdx b/docs/models/operations/listprovidersresponse.mdx index d2a4f58e7..d691c6018 100644 --- a/docs/models/operations/listprovidersresponse.mdx +++ b/docs/models/operations/listprovidersresponse.mdx @@ -9,4 +9,4 @@ Returns a list of providers | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Data` | [][operations.ListProvidersData](../../models/operations/listprovidersdata.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [][operations.ListProvidersData](../../models/operations/listprovidersdata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listrequest.mdx b/docs/models/operations/listrequest.mdx index 9c14a6caf..6c701d095 100644 --- a/docs/models/operations/listrequest.mdx +++ b/docs/models/operations/listrequest.mdx @@ -6,7 +6,7 @@ title: "ListRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `IncludeDisabled` | `*bool` | ➖ | Whether to include disabled API keys in the response | false | -| `IncludeExpired` | `*bool` | ➖ | Whether to include expired API keys in the response. Expired keys are excluded by default and returned only when this is true. | false | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of API keys to skip for pagination | 0 | -| `WorkspaceID` | `*string` | ➖ | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `IncludeDisabled` | `*bool` | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | +| `IncludeExpired` | `*bool` | :heavy_minus_sign: | Whether to include expired API keys in the response. Expired keys are excluded by default and returned only when this is true. | false | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listresponse.mdx b/docs/models/operations/listresponse.mdx index cb8d6a829..43ab0b4e8 100644 --- a/docs/models/operations/listresponse.mdx +++ b/docs/models/operations/listresponse.mdx @@ -9,4 +9,4 @@ List of API keys | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `Data` | [][operations.ListData](../../models/operations/listdata.mdx) | ✅ | List of API keys | \ No newline at end of file +| `Data` | [][operations.ListData](../../models/operations/listdata.mdx) | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupmappingsrequest.mdx b/docs/models/operations/listscimgroupmappingsrequest.mdx index 68638e51c..4a97e8a5d 100644 --- a/docs/models/operations/listscimgroupmappingsrequest.mdx +++ b/docs/models/operations/listscimgroupmappingsrequest.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupMappingsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupmappingsresponse.mdx b/docs/models/operations/listscimgroupmappingsresponse.mdx index 171a46add..1724a2112 100644 --- a/docs/models/operations/listscimgroupmappingsresponse.mdx +++ b/docs/models/operations/listscimgroupmappingsresponse.mdx @@ -6,4 +6,4 @@ title: "ListScimGroupMappingsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListScimGroupMappingsResponse](../../models/components/listscimgroupmappingsresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `Result` | [components.ListScimGroupMappingsResponse](../../models/components/listscimgroupmappingsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupsrequest.mdx b/docs/models/operations/listscimgroupsrequest.mdx index f01cc1b95..e5c722c5e 100644 --- a/docs/models/operations/listscimgroupsrequest.mdx +++ b/docs/models/operations/listscimgroupsrequest.mdx @@ -6,7 +6,7 @@ title: "ListScimGroupsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `DisplayName` | `*string` | ➖ | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | -| `ExternalID` | `*string` | ➖ | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `DisplayName` | `*string` | :heavy_minus_sign: | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | +| `ExternalID` | `*string` | :heavy_minus_sign: | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupsresponse.mdx b/docs/models/operations/listscimgroupsresponse.mdx index 17746edcc..95eac2366 100644 --- a/docs/models/operations/listscimgroupsresponse.mdx +++ b/docs/models/operations/listscimgroupsresponse.mdx @@ -6,4 +6,4 @@ title: "ListScimGroupsResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Result` | [components.ListScimGroupsResponse](../../models/components/listscimgroupsresponse.mdx) | ✅ | N/A | \ No newline at end of file +| `Result` | [components.ListScimGroupsResponse](../../models/components/listscimgroupsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listtoolsrequest.mdx b/docs/models/operations/listtoolsrequest.mdx index a5a2efd67..aea2db8b1 100644 --- a/docs/models/operations/listtoolsrequest.mdx +++ b/docs/models/operations/listtoolsrequest.mdx @@ -6,6 +6,6 @@ title: "ListToolsRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `APIFormat` | [*operations.APIFormat](../../models/operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `APIFormat` | [*operations.APIFormat](../../models/operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | \ No newline at end of file diff --git a/docs/models/operations/listtoolssecurity.mdx b/docs/models/operations/listtoolssecurity.mdx index 0653853e7..5047967a3 100644 --- a/docs/models/operations/listtoolssecurity.mdx +++ b/docs/models/operations/listtoolssecurity.mdx @@ -6,4 +6,4 @@ title: "ListToolsSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bearer` | `string` | ✅ | N/A | \ No newline at end of file +| `Bearer` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listvaultsecretsrequest.mdx b/docs/models/operations/listvaultsecretsrequest.mdx index 6af570247..404a4739c 100644 --- a/docs/models/operations/listvaultsecretsrequest.mdx +++ b/docs/models/operations/listvaultsecretsrequest.mdx @@ -6,5 +6,5 @@ title: "ListVaultSecretsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `Offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `Limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `Offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listvideoscontentrequest.mdx b/docs/models/operations/listvideoscontentrequest.mdx index 00317678a..811aed19b 100644 --- a/docs/models/operations/listvideoscontentrequest.mdx +++ b/docs/models/operations/listvideoscontentrequest.mdx @@ -6,5 +6,5 @@ title: "ListVideosContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `JobID` | `string` | ✅ | N/A | job-abc123 | -| `Index` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | 0 | \ No newline at end of file +| `JobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | +| `Index` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file diff --git a/docs/models/operations/listworkspacebudgetsrequest.mdx b/docs/models/operations/listworkspacebudgetsrequest.mdx index 27445053b..285ebe836 100644 --- a/docs/models/operations/listworkspacebudgetsrequest.mdx +++ b/docs/models/operations/listworkspacebudgetsrequest.mdx @@ -6,4 +6,4 @@ title: "ListWorkspaceBudgetsRequest" | Field | Type | Required | Description | Example | | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `WorkspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `WorkspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersrequest.mdx b/docs/models/operations/listworkspacemembersrequest.mdx index b079e7468..1d615f5d3 100644 --- a/docs/models/operations/listworkspacemembersrequest.mdx +++ b/docs/models/operations/listworkspacemembersrequest.mdx @@ -6,6 +6,6 @@ title: "ListWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersresponse.mdx b/docs/models/operations/listworkspacemembersresponse.mdx index b431f77fb..6aea6b68f 100644 --- a/docs/models/operations/listworkspacemembersresponse.mdx +++ b/docs/models/operations/listworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListWorkspaceMembersResponse](../../models/components/listworkspacemembersresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"id": "660e8400-e29b-41d4-a716-446655440000",
"role": "member",
"user_id": "user_abc123",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListWorkspaceMembersResponse](../../models/components/listworkspacemembersresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"id": "660e8400-e29b-41d4-a716-446655440000",
"role": "member",
"user_id": "user_abc123",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listworkspacesrequest.mdx b/docs/models/operations/listworkspacesrequest.mdx index a06c56edc..ce7543051 100644 --- a/docs/models/operations/listworkspacesrequest.mdx +++ b/docs/models/operations/listworkspacesrequest.mdx @@ -6,5 +6,5 @@ title: "ListWorkspacesRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listworkspacesresponse.mdx b/docs/models/operations/listworkspacesresponse.mdx index cadbd892f..856a6e210 100644 --- a/docs/models/operations/listworkspacesresponse.mdx +++ b/docs/models/operations/listworkspacesresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListWorkspacesResponse](../../models/components/listworkspacesresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListWorkspacesResponse](../../models/components/listworkspacesresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/metadata.mdx b/docs/models/operations/metadata.mdx index 661a437ef..60f9878f4 100644 --- a/docs/models/operations/metadata.mdx +++ b/docs/models/operations/metadata.mdx @@ -6,6 +6,6 @@ title: "Metadata" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `QueryTimeMs` | `float64` | ✅ | N/A | -| `RowCount` | `int64` | ✅ | N/A | -| `Truncated` | `bool` | ✅ | N/A | \ No newline at end of file +| `QueryTimeMs` | `float64` | :heavy_check_mark: | N/A | +| `RowCount` | `int64` | :heavy_check_mark: | N/A | +| `Truncated` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/metric.mdx b/docs/models/operations/metric.mdx index 3c7114eba..9c983230a 100644 --- a/docs/models/operations/metric.mdx +++ b/docs/models/operations/metric.mdx @@ -6,7 +6,7 @@ title: "Metric" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `DisplayFormat` | [operations.DisplayFormat](../../models/operations/displayformat.mdx) | ✅ | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | -| `DisplayLabel` | `string` | ✅ | Human-readable label | Request Count | -| `IsRate` | `bool` | ✅ | Whether this metric is a rate/ratio (averaged, not summed) | | -| `Name` | `string` | ✅ | Metric identifier used in query requests | request_count | \ No newline at end of file +| `DisplayFormat` | [operations.DisplayFormat](../../models/operations/displayformat.mdx) | :heavy_check_mark: | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | +| `DisplayLabel` | `string` | :heavy_check_mark: | Human-readable label | Request Count | +| `IsRate` | `bool` | :heavy_check_mark: | Whether this metric is a rate/ratio (averaged, not summed) | | +| `Name` | `string` | :heavy_check_mark: | Metric identifier used in query requests | request_count | \ No newline at end of file diff --git a/docs/models/operations/operator.mdx b/docs/models/operations/operator.mdx index 5ce4c9608..786e56b5d 100644 --- a/docs/models/operations/operator.mdx +++ b/docs/models/operations/operator.mdx @@ -6,5 +6,5 @@ title: "Operator" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Name` | [operations.OperatorName](../../models/operations/operatorname.mdx) | ✅ | Operator identifier used in filter definitions | eq | -| `ValueType` | [operations.ValueType](../../models/operations/valuetype.mdx) | ✅ | Whether the operator expects a single value or an array | | \ No newline at end of file +| `Name` | [operations.OperatorName](../../models/operations/operatorname.mdx) | :heavy_check_mark: | Operator identifier used in filter definitions | eq | +| `ValueType` | [operations.ValueType](../../models/operations/valuetype.mdx) | :heavy_check_mark: | Whether the operator expects a single value or an array | | \ No newline at end of file diff --git a/docs/models/operations/orderby.mdx b/docs/models/operations/orderby.mdx index 2b32e6627..ddf319027 100644 --- a/docs/models/operations/orderby.mdx +++ b/docs/models/operations/orderby.mdx @@ -6,5 +6,5 @@ title: "OrderBy" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Direction` | [operations.Direction](../../models/operations/direction.mdx) | ✅ | N/A | | -| `Field` | `string` | ✅ | Field to order by: a metric included in `metrics` (or "request_count", which may be ordered by without being requested), a requested dimension, or "date". | request_count | \ No newline at end of file +| `Direction` | [operations.Direction](../../models/operations/direction.mdx) | :heavy_check_mark: | N/A | | +| `Field` | `string` | :heavy_check_mark: | Field to order by: a metric included in `metrics` (or "request_count", which may be ordered by without being requested), a requested dimension, or "date". | request_count | \ No newline at end of file diff --git a/docs/models/operations/promotecontainerfilerequest.mdx b/docs/models/operations/promotecontainerfilerequest.mdx index 88430dcc3..4b11aa693 100644 --- a/docs/models/operations/promotecontainerfilerequest.mdx +++ b/docs/models/operations/promotecontainerfilerequest.mdx @@ -6,5 +6,5 @@ title: "PromoteContainerFileRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `FileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `ContainerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `FileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/prompttokensdetails.mdx b/docs/models/operations/prompttokensdetails.mdx index 9002770fa..2e4644f4b 100644 --- a/docs/models/operations/prompttokensdetails.mdx +++ b/docs/models/operations/prompttokensdetails.mdx @@ -9,8 +9,8 @@ Per-modality token breakdown. Only present when the input contains 2+ modalities | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `AudioTokens` | `*int64` | ➖ | Number of audio tokens in the input | | -| `FileTokens` | `*int64` | ➖ | Number of file/document tokens in the input | | -| `ImageTokens` | `*int64` | ➖ | Number of image tokens in the input | 258 | -| `TextTokens` | `*int64` | ➖ | Number of text tokens in the input | 8 | -| `VideoTokens` | `*int64` | ➖ | Number of video tokens in the input | | \ No newline at end of file +| `AudioTokens` | `*int64` | :heavy_minus_sign: | Number of audio tokens in the input | | +| `FileTokens` | `*int64` | :heavy_minus_sign: | Number of file/document tokens in the input | | +| `ImageTokens` | `*int64` | :heavy_minus_sign: | Number of image tokens in the input | 258 | +| `TextTokens` | `*int64` | :heavy_minus_sign: | Number of text tokens in the input | 8 | +| `VideoTokens` | `*int64` | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/models/operations/provisioninternrequest.mdx b/docs/models/operations/provisioninternrequest.mdx index 95d772496..c8e0762ca 100644 --- a/docs/models/operations/provisioninternrequest.mdx +++ b/docs/models/operations/provisioninternrequest.mdx @@ -6,4 +6,4 @@ title: "ProvisionInternRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsdata2.mdx b/docs/models/operations/queryanalyticsdata2.mdx index 6bc62f306..659d18b72 100644 --- a/docs/models/operations/queryanalyticsdata2.mdx +++ b/docs/models/operations/queryanalyticsdata2.mdx @@ -6,7 +6,7 @@ title: "QueryAnalyticsData2" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CachedAt` | `*float64` | ➖ | N/A | -| `Data` | [][operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1.mdx) | ✅ | N/A | -| `Metadata` | [operations.Metadata](../../models/operations/metadata.mdx) | ✅ | N/A | -| `Warnings` | []`string` | ➖ | Warnings about filter resolution issues (e.g. unresolvable api_key_id hashes). The query still runs normally; these inform the caller that some filter values could not be resolved. | \ No newline at end of file +| `CachedAt` | `*float64` | :heavy_minus_sign: | N/A | +| `Data` | [][operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1.mdx) | :heavy_check_mark: | N/A | +| `Metadata` | [operations.Metadata](../../models/operations/metadata.mdx) | :heavy_check_mark: | N/A | +| `Warnings` | []`string` | :heavy_minus_sign: | Warnings about filter resolution issues (e.g. unresolvable api_key_id hashes). The query still runs normally; these inform the caller that some filter values could not be resolved. | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsrequest.mdx b/docs/models/operations/queryanalyticsrequest.mdx index a3fa0d328..8d6ace311 100644 --- a/docs/models/operations/queryanalyticsrequest.mdx +++ b/docs/models/operations/queryanalyticsrequest.mdx @@ -6,13 +6,13 @@ title: "QueryAnalyticsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClassifierDimensions` | [*operations.ClassifierDimensions](../../models/operations/classifierdimensions.mdx) | ➖ | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | -| `ClassifierFilters` | [*operations.ClassifierFilters](../../models/operations/classifierfilters.mdx) | ➖ | Filter results to generations with specific classifier tag values. Can be combined with classifier_dimensions (must use the same classifier_id) or used independently with standard dimensions. | | -| `Dimensions` | []`string` | ➖ | N/A | | -| `Filters` | [][operations.Filter](../../models/operations/filter.mdx) | ➖ | N/A | | -| `Granularity` | `*string` | ➖ | Time granularity | day | -| `GroupLimit` | `*int64` | ➖ | Maximum rows per distinct combination of dimensions. When omitted on time-series queries (granularity + dimensions), auto-computed to avoid truncating time windows. Explicit values override the default and may truncate time buckets if set lower than the number of buckets in the range. Ignored when no dimensions are specified. | 100 | -| `Limit` | `*int64` | ➖ | Maximum total rows returned. Defaults to 1000. On time-series queries with dimensions and no explicit group_limit, the server may raise this to accommodate the expected number of unique time-bucket/dimension combinations. | | -| `Metrics` | []`string` | ✅ | N/A | | -| `OrderBy` | [*operations.OrderBy](../../models/operations/orderby.mdx) | ➖ | N/A | | -| `TimeRange` | [*operations.TimeRange](../../models/operations/timerange.mdx) | ➖ | N/A | | \ No newline at end of file +| `ClassifierDimensions` | [*operations.ClassifierDimensions](../../models/operations/classifierdimensions.mdx) | :heavy_minus_sign: | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | +| `ClassifierFilters` | [*operations.ClassifierFilters](../../models/operations/classifierfilters.mdx) | :heavy_minus_sign: | Filter results to generations with specific classifier tag values. Can be combined with classifier_dimensions (must use the same classifier_id) or used independently with standard dimensions. | | +| `Dimensions` | []`string` | :heavy_minus_sign: | N/A | | +| `Filters` | [][operations.Filter](../../models/operations/filter.mdx) | :heavy_minus_sign: | N/A | | +| `Granularity` | `*string` | :heavy_minus_sign: | Time granularity | day | +| `GroupLimit` | `*int64` | :heavy_minus_sign: | Maximum rows per distinct combination of dimensions. When omitted on time-series queries (granularity + dimensions), auto-computed to avoid truncating time windows. Explicit values override the default and may truncate time buckets if set lower than the number of buckets in the range. Ignored when no dimensions are specified. | 100 | +| `Limit` | `*int64` | :heavy_minus_sign: | Maximum total rows returned. Defaults to 1000. On time-series queries with dimensions and no explicit group_limit, the server may raise this to accommodate the expected number of unique time-bucket/dimension combinations. | | +| `Metrics` | []`string` | :heavy_check_mark: | N/A | | +| `OrderBy` | [*operations.OrderBy](../../models/operations/orderby.mdx) | :heavy_minus_sign: | N/A | | +| `TimeRange` | [*operations.TimeRange](../../models/operations/timerange.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsresponse.mdx b/docs/models/operations/queryanalyticsresponse.mdx index 96c8f451d..1480df4ab 100644 --- a/docs/models/operations/queryanalyticsresponse.mdx +++ b/docs/models/operations/queryanalyticsresponse.mdx @@ -9,4 +9,4 @@ Analytics query results | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Data` | [operations.QueryAnalyticsData2](../../models/operations/queryanalyticsdata2.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [operations.QueryAnalyticsData2](../../models/operations/queryanalyticsdata2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/ratelimit.mdx b/docs/models/operations/ratelimit.mdx index 8766c1733..f9429824d 100644 --- a/docs/models/operations/ratelimit.mdx +++ b/docs/models/operations/ratelimit.mdx @@ -4,13 +4,13 @@ title: "~~RateLimit~~" Legacy rate limit information about a key. Will always return -1. -> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Fields | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `Interval` | `string` | ✅ | Rate limit interval | 1h | -| `Note` | `string` | ✅ | Note about the rate limit | This field is deprecated and safe to ignore. | -| `Requests` | `int64` | ✅ | Number of requests allowed per interval | 1000 | \ No newline at end of file +| `Interval` | `string` | :heavy_check_mark: | Rate limit interval | 1h | +| `Note` | `string` | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | +| `Requests` | `int64` | :heavy_check_mark: | Number of requests allowed per interval | 1000 | \ No newline at end of file diff --git a/docs/models/operations/result.mdx b/docs/models/operations/result.mdx index 8786c01d0..6a3ad02a4 100644 --- a/docs/models/operations/result.mdx +++ b/docs/models/operations/result.mdx @@ -9,6 +9,6 @@ A single rerank result | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Document` | [operations.DocumentResponse](../../models/operations/documentresponse.mdx) | ✅ | The document object echoing the original input (text and/or image) | | -| `Index` | `int64` | ✅ | Index of the document in the original input list | 0 | -| `RelevanceScore` | `float64` | ✅ | Relevance score of the document to the query | 0.98 | \ No newline at end of file +| `Document` | [operations.DocumentResponse](../../models/operations/documentresponse.mdx) | :heavy_check_mark: | The document object echoing the original input (text and/or image) | | +| `Index` | `int64` | :heavy_check_mark: | Index of the document in the original input list | 0 | +| `RelevanceScore` | `float64` | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/docs/models/operations/sendchatcompletionrequestrequest.mdx b/docs/models/operations/sendchatcompletionrequestrequest.mdx index 60c0fab93..c0c00e2aa 100644 --- a/docs/models/operations/sendchatcompletionrequestrequest.mdx +++ b/docs/models/operations/sendchatcompletionrequestrequest.mdx @@ -6,5 +6,5 @@ title: "SendChatCompletionRequestRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file +| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/signinterndaemonaccessrequestrequest.mdx b/docs/models/operations/signinterndaemonaccessrequestrequest.mdx index 87cbe8857..ffed5a92f 100644 --- a/docs/models/operations/signinterndaemonaccessrequestrequest.mdx +++ b/docs/models/operations/signinterndaemonaccessrequestrequest.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonAccessRequestRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `SignInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `SignInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/signinterndaemonaccessrequestresponse.mdx b/docs/models/operations/signinterndaemonaccessrequestresponse.mdx index e5d118fb5..3d66673bc 100644 --- a/docs/models/operations/signinterndaemonaccessrequestresponse.mdx +++ b/docs/models/operations/signinterndaemonaccessrequestresponse.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonAccessRequestResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | ✅ | N/A | | -| `Result` | [components.SignInternDaemonResponse](../../models/components/signinterndaemonresponse.mdx) | ✅ | N/A | \{
"x-ori-invoke-signature": "MEUCIQ...",
"x-ori-invoke-timestamp": "1789000000",
"x-ori-invoke-user": "user_2abc"
} | \ No newline at end of file +| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | | +| `Result` | [components.SignInternDaemonResponse](../../models/components/signinterndaemonresponse.mdx) | :heavy_check_mark: | N/A | \{
"x-ori-invoke-signature": "MEUCIQ...",
"x-ori-invoke-timestamp": "1789000000",
"x-ori-invoke-user": "user_2abc"
} | \ No newline at end of file diff --git a/docs/models/operations/signinterndaemonrequestrequest.mdx b/docs/models/operations/signinterndaemonrequestrequest.mdx index e8f7436c8..0cdf914aa 100644 --- a/docs/models/operations/signinterndaemonrequestrequest.mdx +++ b/docs/models/operations/signinterndaemonrequestrequest.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonRequestRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `SignInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `SignInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/signinterndaemonrequestresponse.mdx b/docs/models/operations/signinterndaemonrequestresponse.mdx index 32b5e602b..f69184d98 100644 --- a/docs/models/operations/signinterndaemonrequestresponse.mdx +++ b/docs/models/operations/signinterndaemonrequestresponse.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonRequestResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | ✅ | N/A | | -| `Result` | [components.SignInternDaemonResponse](../../models/components/signinterndaemonresponse.mdx) | ✅ | N/A | \{
"x-ori-invoke-signature": "MEUCIQ...",
"x-ori-invoke-timestamp": "1789000000",
"x-ori-invoke-user": "user_2abc"
} | \ No newline at end of file +| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | | +| `Result` | [components.SignInternDaemonResponse](../../models/components/signinterndaemonresponse.mdx) | :heavy_check_mark: | N/A | \{
"x-ori-invoke-signature": "MEUCIQ...",
"x-ori-invoke-timestamp": "1789000000",
"x-ori-invoke-user": "user_2abc"
} | \ No newline at end of file diff --git a/docs/models/operations/storeinternvaultsecretrequest.mdx b/docs/models/operations/storeinternvaultsecretrequest.mdx index 9e07cd195..e1a5e3553 100644 --- a/docs/models/operations/storeinternvaultsecretrequest.mdx +++ b/docs/models/operations/storeinternvaultsecretrequest.mdx @@ -6,6 +6,6 @@ title: "StoreInternVaultSecretRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `Name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `VaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `Name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `VaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file diff --git a/docs/models/operations/storevaultsecretrequest.mdx b/docs/models/operations/storevaultsecretrequest.mdx index b003c000b..cb88f034d 100644 --- a/docs/models/operations/storevaultsecretrequest.mdx +++ b/docs/models/operations/storevaultsecretrequest.mdx @@ -6,5 +6,5 @@ title: "StoreVaultSecretRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `VaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `Name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `VaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file diff --git a/docs/models/operations/suspendinternrequest.mdx b/docs/models/operations/suspendinternrequest.mdx index 13ed51bfc..8c236941f 100644 --- a/docs/models/operations/suspendinternrequest.mdx +++ b/docs/models/operations/suspendinternrequest.mdx @@ -6,4 +6,4 @@ title: "SuspendInternRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/timerange.mdx b/docs/models/operations/timerange.mdx index 36ae7e8ee..b8a3d5f87 100644 --- a/docs/models/operations/timerange.mdx +++ b/docs/models/operations/timerange.mdx @@ -6,5 +6,5 @@ title: "TimeRange" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `End` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `Start` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | \ No newline at end of file +| `End` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `Start` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/docs/models/operations/updatebyokkeyrequest.mdx b/docs/models/operations/updatebyokkeyrequest.mdx index 3260099e3..bc1e0e9cf 100644 --- a/docs/models/operations/updatebyokkeyrequest.mdx +++ b/docs/models/operations/updatebyokkeyrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `UpdateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | ✅ | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `UpdateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file diff --git a/docs/models/operations/updateenduserrequest.mdx b/docs/models/operations/updateenduserrequest.mdx index c93fd9f46..08747ded8 100644 --- a/docs/models/operations/updateenduserrequest.mdx +++ b/docs/models/operations/updateenduserrequest.mdx @@ -4,7 +4,7 @@ title: "UpdateEndUserRequest" ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | -| `UpdateEndUserRequest` | [components.UpdateEndUserRequest](../../models/components/updateenduserrequest.mdx) | ✅ | N/A | \{
"is_active": true
} | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `UpdateEndUserRequest` | [components.UpdateEndUserRequest](../../models/components/updateenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"is_active": true
} | \ No newline at end of file diff --git a/docs/models/operations/updateguardrailrequest.mdx b/docs/models/operations/updateguardrailrequest.mdx index 7a1eb0704..696bfa2bf 100644 --- a/docs/models/operations/updateguardrailrequest.mdx +++ b/docs/models/operations/updateguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `UpdateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | ✅ | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `UpdateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | \ No newline at end of file diff --git a/docs/models/operations/updateinternrequest.mdx b/docs/models/operations/updateinternrequest.mdx index 0224581ca..b2246f46c 100644 --- a/docs/models/operations/updateinternrequest.mdx +++ b/docs/models/operations/updateinternrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `UpdateInternRequest` | [components.UpdateInternRequest](../../models/components/updateinternrequest.mdx) | ✅ | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file +| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `UpdateInternRequest` | [components.UpdateInternRequest](../../models/components/updateinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file diff --git a/docs/models/operations/updatekeysdata.mdx b/docs/models/operations/updatekeysdata.mdx index eff153a50..f54cdf5f8 100644 --- a/docs/models/operations/updatekeysdata.mdx +++ b/docs/models/operations/updatekeysdata.mdx @@ -9,26 +9,26 @@ The updated API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | ✅ | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `ExternalUser` | `*string` | ✅ | Partner's end-user identifier used for attribution. | null | -| `Hash` | `string` | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | -| `Name` | `string` | ✅ | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `ExternalUser` | `*string` | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | +| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | +| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | +| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | +| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/updatekeysrequest.mdx b/docs/models/operations/updatekeysrequest.mdx index ea4ecae6d..b77a48fae 100644 --- a/docs/models/operations/updatekeysrequest.mdx +++ b/docs/models/operations/updatekeysrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `Hash` | `string` | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `RequestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | ✅ | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | \ No newline at end of file +| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `RequestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | \ No newline at end of file diff --git a/docs/models/operations/updatekeysrequestbody.mdx b/docs/models/operations/updatekeysrequestbody.mdx index 15a52daf8..d311f277d 100644 --- a/docs/models/operations/updatekeysrequestbody.mdx +++ b/docs/models/operations/updatekeysrequestbody.mdx @@ -6,8 +6,8 @@ title: "UpdateKeysRequestBody" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Disabled` | `*bool` | ➖ | Whether to disable the API key | false | -| `IncludeBYOKInLimit` | `*bool` | ➖ | Whether to include BYOK usage in the limit | true | -| `Limit` | optionalnullable.OptionalNullable[`float64`] | ➖ | New spending limit for the API key in USD | 75 | -| `LimitReset` | optionalnullable.OptionalNullable[[operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset.mdx)] | ➖ | New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | daily | -| `Name` | `*string` | ➖ | New name for the API key | Updated API Key Name | \ No newline at end of file +| `Disabled` | `*bool` | :heavy_minus_sign: | Whether to disable the API key | false | +| `IncludeBYOKInLimit` | `*bool` | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | +| `Limit` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | +| `LimitReset` | optionalnullable.OptionalNullable[[operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset.mdx)] | :heavy_minus_sign: | New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | daily | +| `Name` | `*string` | :heavy_minus_sign: | New name for the API key | Updated API Key Name | \ No newline at end of file diff --git a/docs/models/operations/updatekeysresponse.mdx b/docs/models/operations/updatekeysresponse.mdx index 16e18855a..540395465 100644 --- a/docs/models/operations/updatekeysresponse.mdx +++ b/docs/models/operations/updatekeysresponse.mdx @@ -9,4 +9,4 @@ API key updated successfully | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [operations.UpdateKeysData](../../models/operations/updatekeysdata.mdx) | ✅ | The updated API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [operations.UpdateKeysData](../../models/operations/updatekeysdata.mdx) | :heavy_check_mark: | The updated API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/operations/updateobservabilitydestinationrequest.mdx b/docs/models/operations/updateobservabilitydestinationrequest.mdx index c85bd7dfa..a32db161a 100644 --- a/docs/models/operations/updateobservabilitydestinationrequest.mdx +++ b/docs/models/operations/updateobservabilitydestinationrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `UpdateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `UpdateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file diff --git a/docs/models/operations/updateorganizationsettingsresponse.mdx b/docs/models/operations/updateorganizationsettingsresponse.mdx index fedc16e52..d635bc072 100644 --- a/docs/models/operations/updateorganizationsettingsresponse.mdx +++ b/docs/models/operations/updateorganizationsettingsresponse.mdx @@ -9,4 +9,4 @@ Organization settings updated successfully | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.OrganizationSettings](../../models/components/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file +| `Data` | [components.OrganizationSettings](../../models/components/organizationsettings.mdx) | :heavy_check_mark: | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file diff --git a/docs/models/operations/updateprivateendpointpricingrequest.mdx b/docs/models/operations/updateprivateendpointpricingrequest.mdx index dfa3c50f1..187463d9b 100644 --- a/docs/models/operations/updateprivateendpointpricingrequest.mdx +++ b/docs/models/operations/updateprivateendpointpricingrequest.mdx @@ -6,5 +6,5 @@ title: "UpdatePrivateEndpointPricingRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `UpdatePrivateEndpointPricingRequest` | [components.UpdatePrivateEndpointPricingRequest](../../models/components/updateprivateendpointpricingrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `UpdatePrivateEndpointPricingRequest` | [components.UpdatePrivateEndpointPricingRequest](../../models/components/updateprivateendpointpricingrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/updateprivateendpointrequest.mdx b/docs/models/operations/updateprivateendpointrequest.mdx index 988d76d47..41c773456 100644 --- a/docs/models/operations/updateprivateendpointrequest.mdx +++ b/docs/models/operations/updateprivateendpointrequest.mdx @@ -6,5 +6,5 @@ title: "UpdatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `UpdatePrivateEndpointRequest` | [components.UpdatePrivateEndpointRequest](../../models/components/updateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `UpdatePrivateEndpointRequest` | [components.UpdatePrivateEndpointRequest](../../models/components/updateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/updatescimgroupmappingrequest.mdx b/docs/models/operations/updatescimgroupmappingrequest.mdx index b83ad3851..4228979be 100644 --- a/docs/models/operations/updatescimgroupmappingrequest.mdx +++ b/docs/models/operations/updatescimgroupmappingrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateScimGroupMappingRequest" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | N/A | -| `UpdateScimGroupMappingRequest` | [components.UpdateScimGroupMappingRequest](../../models/components/updatescimgroupmappingrequest.mdx) | ✅ | N/A | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | N/A | +| `UpdateScimGroupMappingRequest` | [components.UpdateScimGroupMappingRequest](../../models/components/updatescimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/updateworkspacerequest.mdx b/docs/models/operations/updateworkspacerequest.mdx index d921d3f58..3403cdcee 100644 --- a/docs/models/operations/updateworkspacerequest.mdx +++ b/docs/models/operations/updateworkspacerequest.mdx @@ -6,5 +6,5 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `UpdateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | ✅ | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `UpdateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file diff --git a/docs/models/operations/uploadfilefile.mdx b/docs/models/operations/uploadfilefile.mdx index 078a2b7c1..8427f36ed 100644 --- a/docs/models/operations/uploadfilefile.mdx +++ b/docs/models/operations/uploadfilefile.mdx @@ -6,5 +6,5 @@ title: "UploadFileFile" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `FileName` | `string` | ✅ | N/A | -| `Content` | `any` | ✅ | N/A | \ No newline at end of file +| `FileName` | `string` | :heavy_check_mark: | N/A | +| `Content` | `any` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequest.mdx b/docs/models/operations/uploadfilerequest.mdx index bf269f386..673bebcf6 100644 --- a/docs/models/operations/uploadfilerequest.mdx +++ b/docs/models/operations/uploadfilerequest.mdx @@ -6,6 +6,6 @@ title: "UploadFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `RequestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | ✅ | N/A | | \ No newline at end of file +| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `RequestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequestbody.mdx b/docs/models/operations/uploadfilerequestbody.mdx index 9a8f78cae..b16519990 100644 --- a/docs/models/operations/uploadfilerequestbody.mdx +++ b/docs/models/operations/uploadfilerequestbody.mdx @@ -6,4 +6,4 @@ title: "UploadFileRequestBody" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `File` | [operations.UploadFileFile](../../models/operations/uploadfilefile.mdx) | ✅ | N/A | \ No newline at end of file +| `File` | [operations.UploadFileFile](../../models/operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/upsertworkspacebudgetrequest.mdx b/docs/models/operations/upsertworkspacebudgetrequest.mdx index d84d52215..d30a305eb 100644 --- a/docs/models/operations/upsertworkspacebudgetrequest.mdx +++ b/docs/models/operations/upsertworkspacebudgetrequest.mdx @@ -6,6 +6,6 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `WorkspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `UpsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | ✅ | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file +| `WorkspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `UpsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file diff --git a/docs/models/operations/validateprivateendpointrequest.mdx b/docs/models/operations/validateprivateendpointrequest.mdx index afc0b7231..7903e1900 100644 --- a/docs/models/operations/validateprivateendpointrequest.mdx +++ b/docs/models/operations/validateprivateendpointrequest.mdx @@ -6,5 +6,5 @@ title: "ValidatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `ValidatePrivateEndpointRequest` | [components.ValidatePrivateEndpointRequest](../../models/components/validateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file +| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `ValidatePrivateEndpointRequest` | [components.ValidatePrivateEndpointRequest](../../models/components/validateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/badgatewayresponseerror.mdx b/docs/models/sdkerrors/badgatewayresponseerror.mdx index 0ae8aed94..4686d845f 100644 --- a/docs/models/sdkerrors/badgatewayresponseerror.mdx +++ b/docs/models/sdkerrors/badgatewayresponseerror.mdx @@ -9,6 +9,6 @@ Bad Gateway - Provider/upstream API failure | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Error` | [components.BadGatewayResponseErrorData](../../models/components/badgatewayresponseerrordata.mdx) | ✅ | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.BadGatewayResponseErrorData](../../models/components/badgatewayresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/badrequestresponseerror.mdx b/docs/models/sdkerrors/badrequestresponseerror.mdx index 9f6eec8d6..2010057af 100644 --- a/docs/models/sdkerrors/badrequestresponseerror.mdx +++ b/docs/models/sdkerrors/badrequestresponseerror.mdx @@ -9,6 +9,6 @@ Bad Request - Invalid request parameters or malformed input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Error` | [components.BadRequestResponseErrorData](../../models/components/badrequestresponseerrordata.mdx) | ✅ | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.BadRequestResponseErrorData](../../models/components/badrequestresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/batcherrorresponse.mdx b/docs/models/sdkerrors/batcherrorresponse.mdx index 4b6e5d63f..864644026 100644 --- a/docs/models/sdkerrors/batcherrorresponse.mdx +++ b/docs/models/sdkerrors/batcherrorresponse.mdx @@ -6,4 +6,4 @@ title: "BatchErrorResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Error` | [components.BatchErrorResponseError](../../models/components/batcherrorresponseerror.mdx) | ✅ | N/A | \ No newline at end of file +| `Error` | [components.BatchErrorResponseError](../../models/components/batcherrorresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/batchpaymentrequiredresponseerror.mdx b/docs/models/sdkerrors/batchpaymentrequiredresponseerror.mdx index 275d120cd..384ea1eed 100644 --- a/docs/models/sdkerrors/batchpaymentrequiredresponseerror.mdx +++ b/docs/models/sdkerrors/batchpaymentrequiredresponseerror.mdx @@ -9,15 +9,15 @@ Batch metadata with results withheld (results: null) plus the standard error env | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `CompletionWindow` | [components.BatchPaymentRequiredResponseCompletionWindow](../../models/components/batchpaymentrequiredresponsecompletionwindow.mdx) | ✅ | N/A | -| `CreatedAt` | `int64` | ✅ | N/A | -| `Endpoint` | `string` | ✅ | N/A | -| `Error` | [components.BatchPaymentRequiredResponseError](../../models/components/batchpaymentrequiredresponseerror.mdx) | ✅ | N/A | -| `FinalizedAt` | `*int64` | ✅ | N/A | -| `ID` | `string` | ✅ | N/A | -| `Model` | `string` | ✅ | N/A | -| `Object` | [components.BatchPaymentRequiredResponseObject](../../models/components/batchpaymentrequiredresponseobject.mdx) | ✅ | N/A | -| `RequestCounts` | [components.BatchPaymentRequiredResponseRequestCounts](../../models/components/batchpaymentrequiredresponserequestcounts.mdx) | ✅ | N/A | -| `Results` | `any` | ✅ | Always null: results are withheld until the batch charge is covered. | -| `Status` | [components.BatchPaymentRequiredResponseStatus](../../models/components/batchpaymentrequiredresponsestatus.mdx) | ✅ | N/A | -| `Usage` | [*components.BatchPaymentRequiredResponseUsage](../../models/components/batchpaymentrequiredresponseusage.mdx) | ✅ | N/A | \ No newline at end of file +| `CompletionWindow` | [components.BatchPaymentRequiredResponseCompletionWindow](../../models/components/batchpaymentrequiredresponsecompletionwindow.mdx) | :heavy_check_mark: | N/A | +| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | +| `Endpoint` | `string` | :heavy_check_mark: | N/A | +| `Error` | [components.BatchPaymentRequiredResponseError](../../models/components/batchpaymentrequiredresponseerror.mdx) | :heavy_check_mark: | N/A | +| `FinalizedAt` | `*int64` | :heavy_check_mark: | N/A | +| `ID` | `string` | :heavy_check_mark: | N/A | +| `Model` | `string` | :heavy_check_mark: | N/A | +| `Object` | [components.BatchPaymentRequiredResponseObject](../../models/components/batchpaymentrequiredresponseobject.mdx) | :heavy_check_mark: | N/A | +| `RequestCounts` | [components.BatchPaymentRequiredResponseRequestCounts](../../models/components/batchpaymentrequiredresponserequestcounts.mdx) | :heavy_check_mark: | N/A | +| `Results` | `any` | :heavy_check_mark: | Always null: results are withheld until the batch charge is covered. | +| `Status` | [components.BatchPaymentRequiredResponseStatus](../../models/components/batchpaymentrequiredresponsestatus.mdx) | :heavy_check_mark: | N/A | +| `Usage` | [*components.BatchPaymentRequiredResponseUsage](../../models/components/batchpaymentrequiredresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/conflictresponseerror.mdx b/docs/models/sdkerrors/conflictresponseerror.mdx index 579b25f94..a35b87986 100644 --- a/docs/models/sdkerrors/conflictresponseerror.mdx +++ b/docs/models/sdkerrors/conflictresponseerror.mdx @@ -9,6 +9,6 @@ Conflict - Resource conflict or concurrent modification | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.ConflictResponseErrorData](../../models/components/conflictresponseerrordata.mdx) | ✅ | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.ConflictResponseErrorData](../../models/components/conflictresponseerrordata.mdx) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/createprivateendpointvalidationfailedresponseerror.mdx b/docs/models/sdkerrors/createprivateendpointvalidationfailedresponseerror.mdx index 19506f39c..efef1fb31 100644 --- a/docs/models/sdkerrors/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/models/sdkerrors/createprivateendpointvalidationfailedresponseerror.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseError" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.CreatePrivateEndpointValidationFailedResponseData](../../models/components/createprivateendpointvalidationfailedresponsedata.mdx) | ✅ | N/A | -| `Error` | [components.CreatePrivateEndpointValidationFailedResponseError](../../models/components/createprivateendpointvalidationfailedresponseerror.mdx) | ✅ | N/A | \ No newline at end of file +| `Data` | [components.CreatePrivateEndpointValidationFailedResponseData](../../models/components/createprivateendpointvalidationfailedresponsedata.mdx) | :heavy_check_mark: | N/A | +| `Error` | [components.CreatePrivateEndpointValidationFailedResponseError](../../models/components/createprivateendpointvalidationfailedresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx b/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx index 61bfbc5c6..18673bd40 100644 --- a/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx +++ b/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Infrastructure Timeout - Provider request timed out at edge network | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.EdgeNetworkTimeoutResponseErrorData](../../models/components/edgenetworktimeoutresponseerrordata.mdx) | ✅ | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.EdgeNetworkTimeoutResponseErrorData](../../models/components/edgenetworktimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/forbiddenresponseerror.mdx b/docs/models/sdkerrors/forbiddenresponseerror.mdx index 3a025d093..e4947ec51 100644 --- a/docs/models/sdkerrors/forbiddenresponseerror.mdx +++ b/docs/models/sdkerrors/forbiddenresponseerror.mdx @@ -9,6 +9,6 @@ Forbidden - Authentication successful but insufficient permissions | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Error` | [components.ForbiddenResponseErrorData](../../models/components/forbiddenresponseerrordata.mdx) | ✅ | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.ForbiddenResponseErrorData](../../models/components/forbiddenresponseerrordata.mdx) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/gatewaytimeoutresponseerror.mdx b/docs/models/sdkerrors/gatewaytimeoutresponseerror.mdx index effefaea8..feaa27a90 100644 --- a/docs/models/sdkerrors/gatewaytimeoutresponseerror.mdx +++ b/docs/models/sdkerrors/gatewaytimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Gateway Timeout - Provider did not respond before the upstream deadline | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.GatewayTimeoutResponseErrorData](../../models/components/gatewaytimeoutresponseerrordata.mdx) | ✅ | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.GatewayTimeoutResponseErrorData](../../models/components/gatewaytimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/goneresponseerror.mdx b/docs/models/sdkerrors/goneresponseerror.mdx index e796b5a84..98b5222ff 100644 --- a/docs/models/sdkerrors/goneresponseerror.mdx +++ b/docs/models/sdkerrors/goneresponseerror.mdx @@ -9,6 +9,6 @@ Gone - Endpoint has been permanently removed or deprecated | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.GoneResponseErrorData](../../models/components/goneresponseerrordata.mdx) | ✅ | Error data for GoneResponse | \{
"code": 410,
"message": "The Coinbase APIs used by this endpoint have been deprecated, so the Coinbase Commerce credits API has been removed. Use the web credits purchase flow instead."
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.GoneResponseErrorData](../../models/components/goneresponseerrordata.mdx) | :heavy_check_mark: | Error data for GoneResponse | \{
"code": 410,
"message": "The Coinbase APIs used by this endpoint have been deprecated, so the Coinbase Commerce credits API has been removed. Use the web credits purchase flow instead."
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/internalserverresponseerror.mdx b/docs/models/sdkerrors/internalserverresponseerror.mdx index 3ab479ef6..30dde4738 100644 --- a/docs/models/sdkerrors/internalserverresponseerror.mdx +++ b/docs/models/sdkerrors/internalserverresponseerror.mdx @@ -9,6 +9,6 @@ Internal Server Error - Unexpected server error | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.InternalServerResponseErrorData](../../models/components/internalserverresponseerrordata.mdx) | ✅ | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.InternalServerResponseErrorData](../../models/components/internalserverresponseerrordata.mdx) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/internchaterrorresponse.mdx b/docs/models/sdkerrors/internchaterrorresponse.mdx index d503e45cb..069432a03 100644 --- a/docs/models/sdkerrors/internchaterrorresponse.mdx +++ b/docs/models/sdkerrors/internchaterrorresponse.mdx @@ -9,4 +9,4 @@ A refusal before the stream opens. Once the response is `200` and streaming, fai | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.InternChatError](../../models/components/internchaterror.mdx) | ✅ | The OpenAI-compatible error object. `metadata` is present on refusals from the chat route. Authentication refusals (`401`), the departed-creator `403` and the programme `404` carry only `code` and `message`. | \{
"code": 409,
"message": "That question is no longer waiting for an answer.",
"metadata": \{
"reason": "interaction_not_pending",
"retryable": false
}
} | \ No newline at end of file +| `Error` | [components.InternChatError](../../models/components/internchaterror.mdx) | :heavy_check_mark: | The OpenAI-compatible error object. `metadata` is present on refusals from the chat route. Authentication refusals (`401`), the departed-creator `403` and the programme `404` carry only `code` and `message`. | \{
"code": 409,
"message": "That question is no longer waiting for an answer.",
"metadata": \{
"reason": "interaction_not_pending",
"retryable": false
}
} | \ No newline at end of file diff --git a/docs/models/sdkerrors/internlifecycleerror.mdx b/docs/models/sdkerrors/internlifecycleerror.mdx index a500476aa..f938a2177 100644 --- a/docs/models/sdkerrors/internlifecycleerror.mdx +++ b/docs/models/sdkerrors/internlifecycleerror.mdx @@ -9,4 +9,4 @@ Intern lifecycle request failure. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.InternLifecycleErrorError](../../models/components/internlifecycleerrorerror.mdx) | ✅ | N/A | \ No newline at end of file +| `Error` | [components.InternLifecycleErrorError](../../models/components/internlifecycleerrorerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/notfoundresponseerror.mdx b/docs/models/sdkerrors/notfoundresponseerror.mdx index d10dcaf6a..5f17e90bc 100644 --- a/docs/models/sdkerrors/notfoundresponseerror.mdx +++ b/docs/models/sdkerrors/notfoundresponseerror.mdx @@ -9,6 +9,6 @@ Not Found - Resource does not exist | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.NotFoundResponseErrorData](../../models/components/notfoundresponseerrordata.mdx) | ✅ | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.NotFoundResponseErrorData](../../models/components/notfoundresponseerrordata.mdx) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/oautherrorresponse.mdx b/docs/models/sdkerrors/oautherrorresponse.mdx index 44858fe47..5983e5c2c 100644 --- a/docs/models/sdkerrors/oautherrorresponse.mdx +++ b/docs/models/sdkerrors/oautherrorresponse.mdx @@ -9,5 +9,5 @@ RFC 6749 §5.2 error response. | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `Error` | [components.ErrorEnum](../../models/components/errorenum.mdx) | ✅ | N/A | -| `ErrorDescription` | `string` | ✅ | N/A | \ No newline at end of file +| `Error` | [components.ErrorEnum](../../models/components/errorenum.mdx) | :heavy_check_mark: | N/A | +| `ErrorDescription` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx b/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx index 3435e0ef8..9ffad6317 100644 --- a/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx +++ b/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx @@ -9,6 +9,6 @@ Payload Too Large - Request payload exceeds size limits | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.PayloadTooLargeResponseErrorData](../../models/components/payloadtoolargeresponseerrordata.mdx) | ✅ | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.PayloadTooLargeResponseErrorData](../../models/components/payloadtoolargeresponseerrordata.mdx) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/paymentrequiredresponseerror.mdx b/docs/models/sdkerrors/paymentrequiredresponseerror.mdx index e1d5372e6..9716a4008 100644 --- a/docs/models/sdkerrors/paymentrequiredresponseerror.mdx +++ b/docs/models/sdkerrors/paymentrequiredresponseerror.mdx @@ -9,6 +9,6 @@ Payment Required - Insufficient credits or quota to complete request | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.PaymentRequiredResponseErrorData](../../models/components/paymentrequiredresponseerrordata.mdx) | ✅ | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.PaymentRequiredResponseErrorData](../../models/components/paymentrequiredresponseerrordata.mdx) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/provideroverloadedresponseerror.mdx b/docs/models/sdkerrors/provideroverloadedresponseerror.mdx index 3aa231040..511534530 100644 --- a/docs/models/sdkerrors/provideroverloadedresponseerror.mdx +++ b/docs/models/sdkerrors/provideroverloadedresponseerror.mdx @@ -9,6 +9,6 @@ Provider Overloaded - Provider is temporarily overloaded | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.ProviderOverloadedResponseErrorData](../../models/components/provideroverloadedresponseerrordata.mdx) | ✅ | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.ProviderOverloadedResponseErrorData](../../models/components/provideroverloadedresponseerrordata.mdx) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/requesttimeoutresponseerror.mdx b/docs/models/sdkerrors/requesttimeoutresponseerror.mdx index 0c271c702..cb88e051e 100644 --- a/docs/models/sdkerrors/requesttimeoutresponseerror.mdx +++ b/docs/models/sdkerrors/requesttimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Request Timeout - Operation exceeded time limit | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.RequestTimeoutResponseErrorData](../../models/components/requesttimeoutresponseerrordata.mdx) | ✅ | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.RequestTimeoutResponseErrorData](../../models/components/requesttimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/serviceunavailableresponseerror.mdx b/docs/models/sdkerrors/serviceunavailableresponseerror.mdx index 57eee2f80..5a5b3d540 100644 --- a/docs/models/sdkerrors/serviceunavailableresponseerror.mdx +++ b/docs/models/sdkerrors/serviceunavailableresponseerror.mdx @@ -9,6 +9,6 @@ Service Unavailable - Service temporarily unavailable | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.ServiceUnavailableResponseErrorData](../../models/components/serviceunavailableresponseerrordata.mdx) | ✅ | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.ServiceUnavailableResponseErrorData](../../models/components/serviceunavailableresponseerrordata.mdx) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx b/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx index 285f2986a..eb7b7d8fd 100644 --- a/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx +++ b/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx @@ -9,6 +9,6 @@ Too Many Requests - Rate limit exceeded | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.TooManyRequestsResponseErrorData](../../models/components/toomanyrequestsresponseerrordata.mdx) | ✅ | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.TooManyRequestsResponseErrorData](../../models/components/toomanyrequestsresponseerrordata.mdx) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/unauthorizedresponseerror.mdx b/docs/models/sdkerrors/unauthorizedresponseerror.mdx index 0bade8bb6..597ae20a5 100644 --- a/docs/models/sdkerrors/unauthorizedresponseerror.mdx +++ b/docs/models/sdkerrors/unauthorizedresponseerror.mdx @@ -9,6 +9,6 @@ Unauthorized - Authentication required or invalid credentials | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Error` | [components.UnauthorizedResponseErrorData](../../models/components/unauthorizedresponseerrordata.mdx) | ✅ | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.UnauthorizedResponseErrorData](../../models/components/unauthorizedresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/unprocessableentityresponseerror.mdx b/docs/models/sdkerrors/unprocessableentityresponseerror.mdx index ed3137f79..415372530 100644 --- a/docs/models/sdkerrors/unprocessableentityresponseerror.mdx +++ b/docs/models/sdkerrors/unprocessableentityresponseerror.mdx @@ -9,6 +9,6 @@ Unprocessable Entity - Semantic validation failure | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Error` | [components.UnprocessableEntityResponseErrorData](../../models/components/unprocessableentityresponseerrordata.mdx) | ✅ | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | -| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | -| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file +| `Error` | [components.UnprocessableEntityResponseErrorData](../../models/components/unprocessableentityresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | +| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | +| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/sdks/analytics/README.mdx b/docs/sdks/analytics/README.mdx index c60d56907..84d83302a 100644 --- a/docs/sdks/analytics/README.mdx +++ b/docs/sdks/analytics/README.mdx @@ -50,13 +50,13 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `date` | `*string` | ➖ | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `apiKeyHash` | `*string` | ➖ | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `userID` | `*string` | ➖ | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | -| `groupBy` | [*operations.GroupBy](../../models/operations/groupby.mdx) | ➖ | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | -| `workspaceID` | `*string` | ➖ | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `date` | `*string` | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | +| `apiKeyHash` | `*string` | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | +| `userID` | `*string` | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | +| `groupBy` | [*operations.GroupBy](../../models/operations/groupby.mdx) | :heavy_minus_sign: | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | +| `workspaceID` | `*string` | :heavy_minus_sign: | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -110,8 +110,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -178,9 +178,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/apikeys/README.mdx b/docs/sdks/apikeys/README.mdx index d3469fb62..9b084cf94 100644 --- a/docs/sdks/apikeys/README.mdx +++ b/docs/sdks/apikeys/README.mdx @@ -53,8 +53,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -106,12 +106,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `includeDisabled` | `*bool` | ➖ | Whether to include disabled API keys in the response | false | -| `includeExpired` | `*bool` | ➖ | Whether to include expired API keys in the response. Expired keys are excluded by default and returned only when this is true. | false | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of API keys to skip for pagination | 0 | -| `workspaceID` | `*string` | ➖ | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `includeDisabled` | `*bool` | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | +| `includeExpired` | `*bool` | :heavy_minus_sign: | Whether to include expired API keys in the response. Expired keys are excluded by default and returned only when this is true. | false | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | +| `workspaceID` | `*string` | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -173,9 +173,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -229,9 +229,9 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `hash` | `string` | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -284,9 +284,9 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `hash` | `string` | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -373,10 +373,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `hash` | `string` | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | ✅ | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/batch/README.mdx b/docs/sdks/batch/README.mdx index 4f4c9547d..231563cb9 100644 --- a/docs/sdks/batch/README.mdx +++ b/docs/sdks/batch/README.mdx @@ -63,9 +63,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.ListBatchesRequest](../../models/operations/listbatchesrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.ListBatchesRequest](../../models/operations/listbatchesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -278,9 +278,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.BatchSubmitBody](../../models/components/batchsubmitbody.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.BatchSubmitBody](../../models/components/batchsubmitbody.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -331,9 +331,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The batch job id returned from submit. | batch_abc123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -384,9 +384,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The batch job id returned from submit. | batch_abc123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/benchmarks/README.mdx b/docs/sdks/benchmarks/README.mdx index 767f454e6..98e34c943 100644 --- a/docs/sdks/benchmarks/README.mdx +++ b/docs/sdks/benchmarks/README.mdx @@ -51,9 +51,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/betaresponses/README.mdx b/docs/sdks/betaresponses/README.mdx index 3e8ba4a68..71d14851f 100644 --- a/docs/sdks/betaresponses/README.mdx +++ b/docs/sdks/betaresponses/README.mdx @@ -90,10 +90,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/byok/README.mdx b/docs/sdks/byok/README.mdx index 38aa9be17..3848c8b47 100644 --- a/docs/sdks/byok/README.mdx +++ b/docs/sdks/byok/README.mdx @@ -65,12 +65,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspaceID` | `*string` | ➖ | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | -| `provider` | [*operations.Provider](../../models/operations/provider.mdx) | ➖ | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | +| `provider` | [*operations.Provider](../../models/operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -128,9 +128,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.CreateBYOKKeyRequest](../../models/components/createbyokkeyrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.CreateBYOKKeyRequest](../../models/components/createbyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -183,9 +183,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -237,9 +237,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -296,10 +296,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `updateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | ✅ | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `updateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/chat/README.mdx b/docs/sdks/chat/README.mdx index 08af19533..783551d5d 100644 --- a/docs/sdks/chat/README.mdx +++ b/docs/sdks/chat/README.mdx @@ -125,10 +125,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/classifications/README.mdx b/docs/sdks/classifications/README.mdx index f6936e7a5..1ba80d0ad 100644 --- a/docs/sdks/classifications/README.mdx +++ b/docs/sdks/classifications/README.mdx @@ -67,9 +67,9 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `window` | [*operations.Window](../../models/operations/window.mdx) | ➖ | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `window` | [*operations.Window](../../models/operations/window.mdx) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/containers/README.mdx b/docs/sdks/containers/README.mdx index 7b968e73b..11013aa8d 100644 --- a/docs/sdks/containers/README.mdx +++ b/docs/sdks/containers/README.mdx @@ -51,11 +51,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `containerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `limit` | `*int64` | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `after` | `*string` | ➖ | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `containerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `after` | `*string` | :heavy_minus_sign: | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -110,10 +110,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `containerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `containerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -169,10 +169,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `containerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `containerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -239,10 +239,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `containerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `containerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/credits/README.mdx b/docs/sdks/credits/README.mdx index 948523384..7ddbb546f 100644 --- a/docs/sdks/credits/README.mdx +++ b/docs/sdks/credits/README.mdx @@ -48,8 +48,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/datasets/README.mdx b/docs/sdks/datasets/README.mdx index f2439193b..56b4fa796 100644 --- a/docs/sdks/datasets/README.mdx +++ b/docs/sdks/datasets/README.mdx @@ -87,9 +87,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -169,9 +169,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -245,9 +245,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.GetSessionCostRequest](../../models/operations/getsessioncostrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.GetSessionCostRequest](../../models/operations/getsessioncostrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/decisions/README.mdx b/docs/sdks/decisions/README.mdx index e4ea9c6e4..35c24caa3 100644 --- a/docs/sdks/decisions/README.mdx +++ b/docs/sdks/decisions/README.mdx @@ -113,9 +113,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.DecisionsRequest](../../models/components/decisionsrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.DecisionsRequest](../../models/components/decisionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/embeddings/README.mdx b/docs/sdks/embeddings/README.mdx index 997587c02..775d5312a 100644 --- a/docs/sdks/embeddings/README.mdx +++ b/docs/sdks/embeddings/README.mdx @@ -55,9 +55,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -133,10 +133,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/endpoints/README.mdx b/docs/sdks/endpoints/README.mdx index e9d089d67..844044ad6 100644 --- a/docs/sdks/endpoints/README.mdx +++ b/docs/sdks/endpoints/README.mdx @@ -49,8 +49,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -101,10 +101,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `author` | `string` | ✅ | The author/organization of the model | openai | -| `slug` | `string` | ✅ | The model slug | gpt-4 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | +| `slug` | `string` | :heavy_check_mark: | The model slug | gpt-4 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/endusers/README.mdx b/docs/sdks/endusers/README.mdx index f5e4d00f0..32c4de712 100644 --- a/docs/sdks/endusers/README.mdx +++ b/docs/sdks/endusers/README.mdx @@ -63,14 +63,14 @@ func main() { ### Parameters -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `user` | `*string` | ➖ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | -| `includeInactive` | `*bool` | ➖ | Include deactivated registrations. | false | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| Parameter | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `user` | `*string` | :heavy_minus_sign: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `includeInactive` | `*bool` | :heavy_minus_sign: | Include deactivated registrations. | false | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -126,9 +126,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.CreateEndUserRequest](../../models/components/createenduserrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.CreateEndUserRequest](../../models/components/createenduserrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -177,11 +177,11 @@ func main() { ### Parameters -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `user` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| Parameter | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `user` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -232,11 +232,11 @@ func main() { ### Parameters -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `user` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| Parameter | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `user` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -290,12 +290,12 @@ func main() { ### Parameters -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `user` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | -| `updateEndUserRequest` | [components.UpdateEndUserRequest](../../models/components/updateenduserrequest.mdx) | ✅ | N/A | \{
"is_active": true
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| Parameter | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `user` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `updateEndUserRequest` | [components.UpdateEndUserRequest](../../models/components/updateenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"is_active": true
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/files/README.mdx b/docs/sdks/files/README.mdx index 98054ffa0..8087d035c 100644 --- a/docs/sdks/files/README.mdx +++ b/docs/sdks/files/README.mdx @@ -68,9 +68,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -148,11 +148,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | ✅ | N/A | | -| `workspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | +| `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -220,11 +220,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `fileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `fileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -291,11 +291,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `fileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `fileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -352,11 +352,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `fileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `fileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/generations/README.mdx b/docs/sdks/generations/README.mdx index f4d2e84f3..796f1e5d9 100644 --- a/docs/sdks/generations/README.mdx +++ b/docs/sdks/generations/README.mdx @@ -50,9 +50,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The generation ID | gen-1234567890 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -110,9 +110,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The generation ID | gen-1234567890 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -175,9 +175,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.SubmitGenerationFeedbackRequest](../../models/components/submitgenerationfeedbackrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.SubmitGenerationFeedbackRequest](../../models/components/submitgenerationfeedbackrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/guardrails/README.mdx b/docs/sdks/guardrails/README.mdx index b2f6fa11d..6f0e6fdda 100644 --- a/docs/sdks/guardrails/README.mdx +++ b/docs/sdks/guardrails/README.mdx @@ -73,11 +73,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspaceID` | `*string` | ➖ | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspaceID` | `*string` | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -152,9 +152,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.CreateGuardrailRequest](../../models/components/createguardrailrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.CreateGuardrailRequest](../../models/components/createguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -207,9 +207,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -261,9 +261,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -322,10 +322,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `updateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | ✅ | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `updateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -393,11 +393,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -454,10 +454,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -516,10 +516,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -585,11 +585,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -647,10 +647,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -709,10 +709,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -778,10 +778,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -845,10 +845,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/images/README.mdx b/docs/sdks/images/README.mdx index 0090441dc..9abe56d20 100644 --- a/docs/sdks/images/README.mdx +++ b/docs/sdks/images/README.mdx @@ -60,9 +60,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.ImageGenerationRequest](../../models/components/imagegenerationrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.ImageGenerationRequest](../../models/components/imagegenerationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -122,8 +122,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -173,10 +173,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `author` | `string` | ✅ | Model author/organization | bytedance-seed | -| `slug` | `string` | ✅ | Model slug | seedream-4.5 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `author` | `string` | :heavy_check_mark: | Model author/organization | bytedance-seed | +| `slug` | `string` | :heavy_check_mark: | Model slug | seedream-4.5 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/interns/README.mdx b/docs/sdks/interns/README.mdx index 56d6155b9..9a5005ead 100644 --- a/docs/sdks/interns/README.mdx +++ b/docs/sdks/interns/README.mdx @@ -15,8 +15,8 @@ Create, inspect, update, provision, suspend and delete OpenRouter interns throug * [GetIntern](#getintern) - Get an intern * [UpdateIntern](#updateintern) - Update an intern * [GetInternDaemon](#getinterndaemon) - Get an intern's daemon access -* [~~GetInternDaemonAccess~~](#getinterndaemonaccess) - Get an intern's daemon access (deprecated alias) ⚠️ **Deprecated** -* [~~SignInternDaemonAccessRequest~~](#signinterndaemonaccessrequest) - Sign a daemon request with the caller's identity (deprecated alias) ⚠️ **Deprecated** +* [~~GetInternDaemonAccess~~](#getinterndaemonaccess) - Get an intern's daemon access (deprecated alias) :warning: **Deprecated** +* [~~SignInternDaemonAccessRequest~~](#signinterndaemonaccessrequest) - Sign a daemon request with the caller's identity (deprecated alias) :warning: **Deprecated** * [SignInternDaemonRequest](#signinterndaemonrequest) - Sign a daemon request with the caller's identity * [ProvisionIntern](#provisionintern) - Provision an intern * [SuspendIntern](#suspendintern) - Suspend an intern @@ -60,12 +60,12 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `limit` | `*int64` | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | -| `status` | [][operations.Status](../../models/operations/status.mdx) | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `startingAfter` | `*string` | ➖ | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | -| `workspaceID` | `*string` | ➖ | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | +| `status` | [][operations.Status](../../models/operations/status.mdx) | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `startingAfter` | `*string` | :heavy_minus_sign: | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | +| `workspaceID` | `*string` | :heavy_minus_sign: | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -121,10 +121,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `createInternRequest` | [components.CreateInternRequest](../../models/components/createinternrequest.mdx) | ✅ | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | -| `idempotencyKey` | `*string` | ➖ | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `createInternRequest` | [components.CreateInternRequest](../../models/components/createinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | +| `idempotencyKey` | `*string` | :heavy_minus_sign: | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -178,10 +178,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `deleteInternRequest` | [components.DeleteInternRequest](../../models/components/deleteinternrequest.mdx) | ✅ | N/A | \{
"acknowledge_workspace_loss": true
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `deleteInternRequest` | [components.DeleteInternRequest](../../models/components/deleteinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"acknowledge_workspace_loss": true
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -232,9 +232,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -290,10 +290,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `updateInternRequest` | [components.UpdateInternRequest](../../models/components/updateinternrequest.mdx) | ✅ | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `updateInternRequest` | [components.UpdateInternRequest](../../models/components/updateinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -344,9 +344,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -364,7 +364,7 @@ func main() { Deprecated alias of `GET /interns/{internId}/daemon` with the same request, response, and errors. The API key selects the caller, workspace and visible interns. An intern's own API key sees only that intern: the collection and every other intern answer 404 to it. There is no default workspace fallback. Requests on regional hostnames such as `eu.openrouter.ai` are refused. [API key](/docs/api-reference/authentication) required. -> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -399,9 +399,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -419,7 +419,7 @@ func main() { Deprecated alias of `POST /interns/{internId}/daemon/sign` with the same request, response, and errors. The API key selects the caller, workspace and visible interns. An intern's own API key sees only that intern: the collection and every other intern answer 404 to it. There is no default workspace fallback. Requests on regional hostnames such as `eu.openrouter.ai` are refused. [API key](/docs/api-reference/authentication) required. -> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -457,10 +457,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `signInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | ✅ | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `signInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -515,10 +515,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `signInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | ✅ | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `signInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -570,9 +570,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -623,9 +623,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -707,10 +707,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `internChatCompletionRequest` | [components.InternChatCompletionRequest](../../models/components/internchatcompletionrequest.mdx) | ✅ | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `internChatCompletionRequest` | [components.InternChatCompletionRequest](../../models/components/internchatcompletionrequest.mdx) | :heavy_check_mark: | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -772,10 +772,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `internInvokeRequest` | [components.InternInvokeRequest](../../models/components/interninvokerequest.mdx) | ✅ | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `internInvokeRequest` | [components.InternInvokeRequest](../../models/components/interninvokerequest.mdx) | :heavy_check_mark: | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/models/README.mdx b/docs/sdks/models/README.mdx index ba8d99255..a2bd193d0 100644 --- a/docs/sdks/models/README.mdx +++ b/docs/sdks/models/README.mdx @@ -51,10 +51,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `author` | `string` | ✅ | The author/organization of the model | openai | -| `slug` | `string` | ✅ | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | +| `slug` | `string` | :heavy_check_mark: | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -119,9 +119,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -173,9 +173,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `outputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `outputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -241,12 +241,12 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.mdx) | ✅ | The security requirements to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `outputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `outputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/oauth/README.mdx b/docs/sdks/oauth/README.mdx index 968525924..68fdcc465 100644 --- a/docs/sdks/oauth/README.mdx +++ b/docs/sdks/oauth/README.mdx @@ -57,9 +57,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -117,9 +117,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -173,8 +173,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -230,9 +230,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.TokenExchangeRequest](../../models/components/tokenexchangerequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.TokenExchangeRequest](../../models/components/tokenexchangerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/observability/README.mdx b/docs/sdks/observability/README.mdx index 288c06f97..f26db5058 100644 --- a/docs/sdks/observability/README.mdx +++ b/docs/sdks/observability/README.mdx @@ -65,11 +65,11 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `workspaceID` | `*string` | ➖ | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `workspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -168,9 +168,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.CreateObservabilityDestinationRequest](../../models/components/createobservabilitydestinationrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.CreateObservabilityDestinationRequest](../../models/components/createobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -224,9 +224,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -317,9 +317,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -413,10 +413,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `updateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `updateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/organization/README.mdx b/docs/sdks/organization/README.mdx index f59f12867..342718836 100644 --- a/docs/sdks/organization/README.mdx +++ b/docs/sdks/organization/README.mdx @@ -63,10 +63,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -118,8 +118,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -174,9 +174,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.UpdateOrganizationSettingsRequest](../../models/components/updateorganizationsettingsrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.UpdateOrganizationSettingsRequest](../../models/components/updateorganizationsettingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/presets/README.mdx b/docs/sdks/presets/README.mdx index 4d27ecf62..95c801d89 100644 --- a/docs/sdks/presets/README.mdx +++ b/docs/sdks/presets/README.mdx @@ -67,10 +67,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -122,9 +122,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -200,10 +200,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -273,10 +273,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest.mdx) | ✅ | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -339,10 +339,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -410,11 +410,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -467,10 +467,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | -| `version` | `string` | ✅ | Version number of the preset. | 1 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | +| `version` | `string` | :heavy_check_mark: | Version number of the preset. | 1 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/privateendpoints/README.mdx b/docs/sdks/privateendpoints/README.mdx index 249f7efbd..77c990d7a 100644 --- a/docs/sdks/privateendpoints/README.mdx +++ b/docs/sdks/privateendpoints/README.mdx @@ -57,8 +57,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -116,10 +116,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `createPrivateEndpointRequest` | [components.CreatePrivateEndpointRequest](../../models/components/createprivateendpointrequest.mdx) | ✅ | N/A | | -| `idempotencyKey` | `*string` | ➖ | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `createPrivateEndpointRequest` | [components.CreatePrivateEndpointRequest](../../models/components/createprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | +| `idempotencyKey` | `*string` | :heavy_minus_sign: | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -177,10 +177,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `draftOnly` | [*operations.DraftOnly](../../models/operations/draftonly.mdx) | ➖ | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `draftOnly` | [*operations.DraftOnly](../../models/operations/draftonly.mdx) | :heavy_minus_sign: | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -238,9 +238,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -297,10 +297,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `updatePrivateEndpointRequest` | [components.UpdatePrivateEndpointRequest](../../models/components/updateprivateendpointrequest.mdx) | ✅ | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `updatePrivateEndpointRequest` | [components.UpdatePrivateEndpointRequest](../../models/components/updateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -358,9 +358,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -418,9 +418,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -478,9 +478,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -544,10 +544,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `updatePrivateEndpointPricingRequest` | [components.UpdatePrivateEndpointPricingRequest](../../models/components/updateprivateendpointpricingrequest.mdx) | ✅ | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `updatePrivateEndpointPricingRequest` | [components.UpdatePrivateEndpointPricingRequest](../../models/components/updateprivateendpointpricingrequest.mdx) | :heavy_check_mark: | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -608,10 +608,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `validatePrivateEndpointRequest` | [components.ValidatePrivateEndpointRequest](../../models/components/validateprivateendpointrequest.mdx) | ✅ | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `validatePrivateEndpointRequest` | [components.ValidatePrivateEndpointRequest](../../models/components/validateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/providers/README.mdx b/docs/sdks/providers/README.mdx index 227492908..783dc0ff4 100644 --- a/docs/sdks/providers/README.mdx +++ b/docs/sdks/providers/README.mdx @@ -48,8 +48,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/rerank/README.mdx b/docs/sdks/rerank/README.mdx index 7ebb963e4..011e7075f 100644 --- a/docs/sdks/rerank/README.mdx +++ b/docs/sdks/rerank/README.mdx @@ -60,9 +60,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/responses/README.mdx b/docs/sdks/responses/README.mdx index 69d192efe..ab1b772c8 100644 --- a/docs/sdks/responses/README.mdx +++ b/docs/sdks/responses/README.mdx @@ -90,10 +90,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/scim/README.mdx b/docs/sdks/scim/README.mdx index 436b1e124..4ea2865ff 100644 --- a/docs/sdks/scim/README.mdx +++ b/docs/sdks/scim/README.mdx @@ -68,10 +68,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -128,9 +128,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.CreateScimGroupMappingRequest](../../models/components/createscimgroupmappingrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.CreateScimGroupMappingRequest](../../models/components/createscimgroupmappingrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -187,10 +187,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | N/A | | -| `keepMembers` | [operations.KeepMembers](../../models/operations/keepmembers.mdx) | ✅ | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | N/A | | +| `keepMembers` | [operations.KeepMembers](../../models/operations/keepmembers.mdx) | :heavy_check_mark: | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -243,9 +243,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `id` | `string` | ✅ | N/A | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `id` | `string` | :heavy_check_mark: | N/A | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -300,10 +300,10 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `id` | `string` | ✅ | N/A | -| `updateScimGroupMappingRequest` | [components.UpdateScimGroupMappingRequest](../../models/components/updatescimgroupmappingrequest.mdx) | ✅ | N/A | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `id` | `string` | :heavy_check_mark: | N/A | +| `updateScimGroupMappingRequest` | [components.UpdateScimGroupMappingRequest](../../models/components/updatescimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -369,12 +369,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `displayName` | `*string` | ➖ | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | -| `externalID` | `*string` | ➖ | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `displayName` | `*string` | :heavy_minus_sign: | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | +| `externalID` | `*string` | :heavy_minus_sign: | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -426,8 +426,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -479,9 +479,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `id` | `string` | ✅ | N/A | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `id` | `string` | :heavy_check_mark: | N/A | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/stt/README.mdx b/docs/sdks/stt/README.mdx index bb119e8d6..7ec08b4d2 100644 --- a/docs/sdks/stt/README.mdx +++ b/docs/sdks/stt/README.mdx @@ -59,9 +59,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.STTRequest](../../models/components/sttrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.STTRequest](../../models/components/sttrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -136,9 +136,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/systemone/README.mdx b/docs/sdks/systemone/README.mdx index 34a3142d7..cd471b881 100644 --- a/docs/sdks/systemone/README.mdx +++ b/docs/sdks/systemone/README.mdx @@ -113,9 +113,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.DecisionsRequest](../../models/components/decisionsrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.DecisionsRequest](../../models/components/decisionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/tools/README.mdx b/docs/sdks/tools/README.mdx index 110d5db8b..5edb3770d 100644 --- a/docs/sdks/tools/README.mdx +++ b/docs/sdks/tools/README.mdx @@ -51,12 +51,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `security` | [operations.ListToolsSecurity](../../models/operations/listtoolssecurity.mdx) | ✅ | The security requirements to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `apiFormat` | [*operations.APIFormat](../../models/operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `security` | [operations.ListToolsSecurity](../../models/operations/listtoolssecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `apiFormat` | [*operations.APIFormat](../../models/operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -110,10 +110,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `security` | [operations.GetToolSecurity](../../models/operations/gettoolsecurity.mdx) | ✅ | The security requirements to use for the request. | | -| `name` | `string` | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `security` | [operations.GetToolSecurity](../../models/operations/gettoolsecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | | +| `name` | `string` | :heavy_check_mark: | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/tts/README.mdx b/docs/sdks/tts/README.mdx index 94971c4f8..f66abb8ed 100644 --- a/docs/sdks/tts/README.mdx +++ b/docs/sdks/tts/README.mdx @@ -56,9 +56,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.SpeechRequest](../../models/components/speechrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.SpeechRequest](../../models/components/speechrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/vault/README.mdx b/docs/sdks/vault/README.mdx index 1b2778bb0..beee20790 100644 --- a/docs/sdks/vault/README.mdx +++ b/docs/sdks/vault/README.mdx @@ -55,11 +55,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -118,11 +118,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -178,10 +178,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -756,11 +756,11 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `vaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `vaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -1321,10 +1321,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `vaultSecretCopyRequest` | [components.VaultSecretCopyRequest](../../models/components/vaultsecretcopyrequest.mdx) | ✅ | N/A | \{
"names": [
"github_token"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `vaultSecretCopyRequest` | [components.VaultSecretCopyRequest](../../models/components/vaultsecretcopyrequest.mdx) | :heavy_check_mark: | N/A | \{
"names": [
"github_token"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -1385,10 +1385,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -1444,9 +1444,9 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -1987,10 +1987,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `vaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `vaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/docs/sdks/videogeneration/README.mdx b/docs/sdks/videogeneration/README.mdx index 85a34f74c..6f4b35271 100644 --- a/docs/sdks/videogeneration/README.mdx +++ b/docs/sdks/videogeneration/README.mdx @@ -58,9 +58,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.VideoGenerationRequest](../../models/components/videogenerationrequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.VideoGenerationRequest](../../models/components/videogenerationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -117,9 +117,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `jobID` | `string` | ✅ | N/A | job-abc123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `jobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -173,10 +173,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `jobID` | `string` | ✅ | N/A | job-abc123 | -| `index` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `jobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | +| `index` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | 0 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -233,8 +233,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response diff --git a/docs/sdks/workspaces/README.mdx b/docs/sdks/workspaces/README.mdx index b289ac7ce..0a80d3392 100644 --- a/docs/sdks/workspaces/README.mdx +++ b/docs/sdks/workspaces/README.mdx @@ -72,10 +72,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -135,9 +135,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | -| `request` | [components.CreateWorkspaceRequest](../../models/components/createworkspacerequest.mdx) | ✅ | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | +| `request` | [components.CreateWorkspaceRequest](../../models/components/createworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | ### Response @@ -190,10 +190,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `confirmDefaultWorkspaceDeletion` | `*bool` | ➖ | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `confirmDefaultWorkspaceDeletion` | `*bool` | :heavy_minus_sign: | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -247,9 +247,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -305,10 +305,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `updateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | ✅ | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `updateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -375,11 +375,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -438,10 +438,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `bulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `bulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -501,10 +501,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `bulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `bulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -558,9 +558,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `workspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `workspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -613,10 +613,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `workspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `workspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -670,10 +670,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `workspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `workspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response @@ -730,11 +730,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | -| `workspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `upsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | ✅ | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | +| `workspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `upsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | ### Response diff --git a/models/components/createenduserrequest.go b/models/components/createenduserrequest.go index b2acc2282..196bd3776 100644 --- a/models/components/createenduserrequest.go +++ b/models/components/createenduserrequest.go @@ -3,7 +3,7 @@ package components type CreateEndUserRequest struct { - // Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. + // Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. User string `json:"user"` } diff --git a/models/components/enduser.go b/models/components/enduser.go index 29686a12a..74b83e87a 100644 --- a/models/components/enduser.go +++ b/models/components/enduser.go @@ -14,7 +14,7 @@ type EndUser struct { IsActive bool `json:"is_active"` // Last registration lifecycle update time. UpdatedAt time.Time `json:"updated_at"` - // Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. + // Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. User string `json:"user"` } diff --git a/models/operations/deleteenduser.go b/models/operations/deleteenduser.go index 6c9c95408..e50348f29 100644 --- a/models/operations/deleteenduser.go +++ b/models/operations/deleteenduser.go @@ -3,7 +3,7 @@ package operations type DeleteEndUserRequest struct { - // Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. + // Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. User string `pathParam:"style=simple,explode=false,name=user"` } diff --git a/models/operations/getenduser.go b/models/operations/getenduser.go index 0caffce69..748955cbd 100644 --- a/models/operations/getenduser.go +++ b/models/operations/getenduser.go @@ -3,7 +3,7 @@ package operations type GetEndUserRequest struct { - // Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. + // Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. User string `pathParam:"style=simple,explode=false,name=user"` } diff --git a/models/operations/listendusers.go b/models/operations/listendusers.go index e2bcd200f..2b552c4ca 100644 --- a/models/operations/listendusers.go +++ b/models/operations/listendusers.go @@ -13,7 +13,7 @@ type ListEndUsersRequest struct { Offset optionalnullable.OptionalNullable[int64] `default:"0" queryParam:"style=form,explode=true,name=offset"` // Maximum number of records to return (max 100) Limit *int64 `default:"50" queryParam:"style=form,explode=true,name=limit"` - // Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. + // Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. User *string `queryParam:"style=form,explode=true,name=user"` // Include deactivated registrations. IncludeInactive *bool `default:"false" queryParam:"style=form,explode=true,name=include_inactive"` diff --git a/models/operations/updateenduser.go b/models/operations/updateenduser.go index 0c34e0c67..c337b4540 100644 --- a/models/operations/updateenduser.go +++ b/models/operations/updateenduser.go @@ -7,7 +7,7 @@ import ( ) type UpdateEndUserRequest struct { - // Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. + // Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. User string `pathParam:"style=simple,explode=false,name=user"` UpdateEndUserRequest components.UpdateEndUserRequest `request:"mediaType=application/json"` } diff --git a/openrouter.go b/openrouter.go index bfc05ca81..94e6e806d 100644 --- a/openrouter.go +++ b/openrouter.go @@ -234,9 +234,9 @@ func WithTimeout(timeout time.Duration) SDKOption { // New creates a new instance of the SDK with the provided options func New(opts ...SDKOption) *OpenRouter { sdk := &OpenRouter{ - SDKVersion: "0.9.36", + SDKVersion: "0.9.37", sdkConfiguration: config.SDKConfiguration{ - UserAgent: "speakeasy-sdk/go 0.9.36 2.914.0 1.0.0 github.com/OpenRouterTeam/go-sdk", + UserAgent: "speakeasy-sdk/go 0.9.37 2.914.0 1.0.0 github.com/OpenRouterTeam/go-sdk", Globals: globals.Globals{}, ServerList: ServerList, }, From 7356ca3a9fffbd8718450e5a5f20b6872e000f7a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 9 Oct 2026 00:21:18 +0000 Subject: [PATCH 2/3] docs: sync install snippets to v0.9.37 --- OVERVIEW.md | 2 +- README.md | 2 +- doc.go | 2 +- example_test.go | 2 +- examples/README.md | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/OVERVIEW.md b/OVERVIEW.md index 3dfcfd476..092bcc9b2 100644 --- a/OVERVIEW.md +++ b/OVERVIEW.md @@ -117,7 +117,7 @@ go get github.com/OpenRouterTeam/go-sdk For beta releases, pin an explicit version: ```bash -go get github.com/OpenRouterTeam/go-sdk@v0.9.36 +go get github.com/OpenRouterTeam/go-sdk@v0.9.37 ``` **Requirements:** Go 1.25 or higher diff --git a/README.md b/README.md index 8896d35b5..65791babe 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ To learn more, see the [API Reference](https://openrouter.ai/docs/sdks/go/api-re > This SDK is in **beta**. Pin to a specific version to avoid unexpected breaking changes: > > ```bash -> go get github.com/OpenRouterTeam/go-sdk@v0.9.36 +> go get github.com/OpenRouterTeam/go-sdk@v0.9.37 > ``` diff --git a/doc.go b/doc.go index 8a14ab3d6..6834cca8c 100644 --- a/doc.go +++ b/doc.go @@ -6,7 +6,7 @@ provider selection, and unified billing. This SDK is in beta. Pin to a specific module version to avoid unexpected breaking changes: - go get github.com/OpenRouterTeam/go-sdk@v0.9.36 + go get github.com/OpenRouterTeam/go-sdk@v0.9.37 For full API documentation, visit: https://openrouter.ai/docs/client-sdks/go/overview diff --git a/example_test.go b/example_test.go index 2f55fdfb2..f8afdeca5 100644 --- a/example_test.go +++ b/example_test.go @@ -18,7 +18,7 @@ func ExampleNew() { openrouter.WithSecurity("your-api-key"), ) fmt.Println(sdk.SDKVersion) - // Output: 0.9.36 + // Output: 0.9.37 } // Example demonstrates basic usage of the OpenRouter SDK for chat completions. diff --git a/examples/README.md b/examples/README.md index bce10c0da..de2141b25 100644 --- a/examples/README.md +++ b/examples/README.md @@ -43,7 +43,7 @@ cd ../generation && go run . Each example pins a released SDK version in `go.mod`: ```go -require github.com/OpenRouterTeam/go-sdk v0.9.36 +require github.com/OpenRouterTeam/go-sdk v0.9.37 ``` This should match the version in [README.md](../README.md) and `.speakeasy/gen.lock` `releaseVersion`. CI runs `scripts/bump-examples.sh` after releases to keep these in sync. @@ -51,7 +51,7 @@ This should match the version in [README.md](../README.md) and `.speakeasy/gen.l To use a different version: ```bash -go get github.com/OpenRouterTeam/go-sdk@v0.9.36 +go get github.com/OpenRouterTeam/go-sdk@v0.9.37 go run . ``` From 9925f99e37db947f852eb46622b18648ac45fc3b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 9 Oct 2026 00:21:34 +0000 Subject: [PATCH 3/3] Chore: regenerate docs navigation Auto-generated-by: update-generated-files-action; https://github.com/OpenRouterTeam/go-sdk/actions/runs/37864346075 --- docs/models/components/aabenchmarkentry.mdx | 6 +- docs/models/components/activityitem.mdx | 26 +- docs/models/components/activityresponse.mdx | 2 +- .../models/components/additionaltoolsitem.mdx | 8 +- .../components/additionaltoolsitemtool.mdx | 4 +- .../additionaltoolsitemtoolfunction.mdx | 14 +- docs/models/components/advisorreasoning.mdx | 4 +- .../components/advisorservertoolconfig.mdx | 16 +- .../advisorservertoolopenrouter.mdx | 4 +- docs/models/components/agent.mdx | 4 +- docs/models/components/agentmessageitem.mdx | 14 +- .../agentmessageitemcontentinputimage.mdx | 8 +- docs/models/components/alignment.mdx | 2 +- .../components/alignmentallowedcallrecord.mdx | 6 +- .../components/alignmentblockedcallrecord.mdx | 6 +- docs/models/components/alignmentchataudio.mdx | 4 +- docs/models/components/alignmentchatimage.mdx | 4 +- .../components/alignmentchatimageimageurl.mdx | 2 +- .../components/alignmentchatrejected.mdx | 12 +- .../components/alignmentchattoolcall.mdx | 6 +- .../alignmentchattoolcallfunction.mdx | 4 +- docs/models/components/alignmentplugin.mdx | 12 +- .../models/components/alignmentrulerecord.mdx | 4 +- .../alignmentunavailablecallrecord.mdx | 6 +- docs/models/components/allowedtools.mdx | 4 +- docs/models/components/always.mdx | 2 +- .../components/annotationaddedevent.mdx | 14 +- docs/models/components/annotationfile.mdx | 4 +- .../components/annotationurlcitation.mdx | 4 +- .../annotationwebsearchcitation.mdx | 4 +- .../anthropicadvisormessageusageiteration.mdx | 14 +- .../components/anthropicadvisortoolresult.mdx | 6 +- .../components/anthropicbase64imagesource.mdx | 6 +- .../components/anthropicbase64pdfsource.mdx | 6 +- .../anthropicbashcodeexecutionoutput.mdx | 4 +- .../anthropicbashcodeexecutionresult.mdx | 10 +- .../anthropicbashcodeexecutiontoolresult.mdx | 6 +- ...hropicbashcodeexecutiontoolresulterror.mdx | 4 +- .../anthropiccachecontroldirective.mdx | 4 +- .../components/anthropiccachecreation.mdx | 4 +- .../anthropiccitationcharlocation.mdx | 14 +- .../anthropiccitationcharlocationparam.mdx | 12 +- .../anthropiccitationcontentblocklocation.mdx | 14 +- ...ropiccitationcontentblocklocationparam.mdx | 12 +- .../anthropiccitationpagelocation.mdx | 14 +- .../anthropiccitationpagelocationparam.mdx | 12 +- .../components/anthropiccitationsconfig.mdx | 2 +- .../anthropiccitationsearchresultlocation.mdx | 14 +- ...ropiccitationsearchresultlocationparam.mdx | 14 +- ...thropiccitationwebsearchresultlocation.mdx | 10 +- ...iccitationwebsearchresultlocationparam.mdx | 10 +- .../anthropiccodeexecution20250825caller.mdx | 4 +- .../anthropiccodeexecution20260120caller.mdx | 4 +- .../anthropiccodeexecutionoutput.mdx | 4 +- .../anthropiccodeexecutionresult.mdx | 10 +- .../anthropiccodeexecutiontoolresult.mdx | 6 +- .../anthropiccodeexecutiontoolresulterror.mdx | 4 +- .../components/anthropiccompactionblock.mdx | 6 +- .../anthropiccompactionusageiteration.mdx | 12 +- docs/models/components/anthropiccontainer.mdx | 6 +- .../components/anthropiccontainerskill.mdx | 6 +- .../components/anthropiccontainerupload.mdx | 4 +- .../components/anthropicdirectcaller.mdx | 2 +- .../components/anthropicdocumentblock.mdx | 8 +- .../anthropicdocumentblockparam.mdx | 12 +- .../anthropicdocumentblockparamcitations.mdx | 2 +- .../anthropicencryptedcodeexecutionresult.mdx | 10 +- docs/models/components/anthropicfile.mdx | 16 +- .../components/anthropicfiledeleted.mdx | 6 +- .../anthropicfiledocumentsource.mdx | 4 +- docs/models/components/anthropicfilelist.mdx | 10 +- .../components/anthropicimageblockparam.mdx | 6 +- .../anthropicinputtokensclearatleast.mdx | 4 +- .../anthropicinputtokenstrigger.mdx | 4 +- .../anthropicinputtransformation.mdx | 8 +- .../anthropiciterationcachecreation.mdx | 4 +- .../anthropicmessageoutputconfig.mdx | 2 +- .../anthropicmessageusageiteration.mdx | 14 +- .../anthropicoutputtokensdetails.mdx | 2 +- .../components/anthropicplaintextsource.mdx | 6 +- .../anthropicredactedthinkingblock.mdx | 4 +- .../anthropicrefusalstopdetails.mdx | 6 +- docs/models/components/anthropicsafeguard.mdx | 6 +- .../anthropicsearchresultblockparam.mdx | 12 +- ...thropicsearchresultblockparamcitations.mdx | 2 +- .../components/anthropicservertoolusage.mdx | 4 +- docs/models/components/anthropictextblock.mdx | 6 +- .../components/anthropictextblockparam.mdx | 8 +- ...pictexteditorcodeexecutioncreateresult.mdx | 4 +- ...exteditorcodeexecutionstrreplaceresult.mdx | 12 +- ...ropictexteditorcodeexecutiontoolresult.mdx | 6 +- ...texteditorcodeexecutiontoolresulterror.mdx | 6 +- ...ropictexteditorcodeexecutionviewresult.mdx | 12 +- .../components/anthropicthinkingblock.mdx | 6 +- .../anthropicthinkingblockbinding.mdx | 4 +- .../components/anthropicthinkingturns.mdx | 4 +- .../components/anthropictoolreference.mdx | 4 +- .../components/anthropictoolsearchresult.mdx | 4 +- .../anthropictoolsearchresulterror.mdx | 6 +- .../anthropictoolsearchtoolbm25.mdx | 12 +- .../anthropictoolsearchtoolregex.mdx | 12 +- .../anthropictoolsearchtoolresult.mdx | 6 +- .../components/anthropictooluseblock.mdx | 10 +- .../components/anthropictooluseskeep.mdx | 4 +- .../components/anthropictoolusestrigger.mdx | 4 +- .../anthropicunknownusageiteration.mdx | 12 +- .../components/anthropicurlimagesource.mdx | 4 +- .../components/anthropicurlpdfsource.mdx | 4 +- .../components/anthropicwebfetchblock.mdx | 8 +- .../anthropicwebfetchtoolresult.mdx | 8 +- .../anthropicwebfetchtoolresulterror.mdx | 4 +- .../components/anthropicwebsearchresult.mdx | 10 +- .../anthropicwebsearchresultblockparam.mdx | 10 +- .../anthropicwebsearchtoolresult.mdx | 8 +- .../anthropicwebsearchtoolresulterror.mdx | 4 +- .../anthropicwebsearchtooluserlocation.mdx | 10 +- docs/models/components/applypatchcallitem.mdx | 10 +- .../applypatchcalloperationdiffdeltaevent.mdx | 10 +- .../applypatchcalloperationdiffdoneevent.mdx | 10 +- .../components/applypatchcalloutputitem.mdx | 10 +- .../applypatchcreatefileoperation.mdx | 6 +- .../applypatchdeletefileoperation.mdx | 4 +- .../components/applypatchservertool.mdx | 2 +- .../components/applypatchservertoolconfig.mdx | 2 +- .../applypatchservertoolopenrouter.mdx | 4 +- .../applypatchupdatefileoperation.mdx | 6 +- docs/models/components/apprankingsitem.mdx | 10 +- .../models/components/apprankingsresponse.mdx | 4 +- docs/models/components/architecture.mdx | 10 +- docs/models/components/audiourl.mdx | 2 +- .../components/autobetarouterplugin.mdx | 12 +- docs/models/components/autorouterplugin.mdx | 14 +- .../badgatewayresponseerrordata.mdx | 6 +- .../badrequestresponseerrordata.mdx | 6 +- docs/models/components/baseinputsmessage.mdx | 8 +- .../models/components/basereasoningconfig.mdx | 8 +- docs/models/components/bashservertool.mdx | 4 +- .../components/bashservertoolconfig.mdx | 4 +- docs/models/components/batchdeletedobject.mdx | 6 +- .../components/batchdeletiontargets.mdx | 4 +- .../components/batcherrorresponseerror.mdx | 4 +- docs/models/components/batchlistitem.mdx | 24 +- .../batchlistitemcompletiontokensdetails.mdx | 6 +- docs/models/components/batchlistitemerror.mdx | 2 +- .../batchlistitemprompttokensdetails.mdx | 10 +- .../components/batchlistitemrequestcounts.mdx | 6 +- .../components/batchlistitemservertooluse.mdx | 6 +- docs/models/components/batchlistitemusage.mdx | 26 +- docs/models/components/batchlistresponse.mdx | 10 +- docs/models/components/batchobject.mdx | 24 +- .../batchobjectcompletiontokensdetails.mdx | 6 +- docs/models/components/batchobjectdata.mdx | 6 +- docs/models/components/batchobjectdebug.mdx | 6 +- docs/models/components/batchobjecterror.mdx | 2 +- docs/models/components/batchobjectfile.mdx | 6 +- .../models/components/batchobjectfunction.mdx | 4 +- .../models/components/batchobjectimageurl.mdx | 2 +- .../batchobjectprompttokensdetails.mdx | 10 +- .../components/batchobjectrequestcounts.mdx | 6 +- .../models/components/batchobjectresponse.mdx | 6 +- .../components/batchobjectservertooluse.mdx | 6 +- .../batchobjectservertoolusedetails.mdx | 6 +- docs/models/components/batchobjecttimings.mdx | 6 +- .../components/batchobjecturlcitation.mdx | 10 +- docs/models/components/batchobjectusage.mdx | 26 +- ...equiredresponsecompletiontokensdetails.mdx | 6 +- .../batchpaymentrequiredresponseerror.mdx | 4 +- ...entrequiredresponseprompttokensdetails.mdx | 10 +- ...chpaymentrequiredresponserequestcounts.mdx | 6 +- ...chpaymentrequiredresponseservertooluse.mdx | 6 +- .../batchpaymentrequiredresponseusage.mdx | 26 +- .../components/batchproviderpreferences.mdx | 4 +- docs/models/components/batchsubmitbody.mdx | 10 +- docs/models/components/bodychatcompletion.mdx | 24 +- .../bodycompletiontokensdetails.mdx | 6 +- docs/models/components/bodylist.mdx | 10 +- docs/models/components/bodymessage.mdx | 22 +- .../components/bodyprompttokensdetails1.mdx | 10 +- .../components/bodyprompttokensdetails2.mdx | 10 +- docs/models/components/bodyservertooluse.mdx | 6 +- docs/models/components/bodyusage1.mdx | 14 +- docs/models/components/bodyusage2.mdx | 22 +- docs/models/components/bodyusage3.mdx | 12 +- docs/models/components/booleancapability.mdx | 2 +- .../bulkaddworkspacemembersrequest.mdx | 2 +- .../bulkaddworkspacemembersresponse.mdx | 4 +- .../components/bulkassignkeysrequest.mdx | 2 +- .../components/bulkassignkeysresponse.mdx | 2 +- .../components/bulkassignmembersrequest.mdx | 2 +- .../components/bulkassignmembersresponse.mdx | 2 +- .../bulkremoveworkspacemembersrequest.mdx | 2 +- .../bulkremoveworkspacemembersresponse.mdx | 2 +- .../components/bulkunassignkeysrequest.mdx | 2 +- .../components/bulkunassignkeysresponse.mdx | 2 +- .../components/bulkunassignmembersrequest.mdx | 2 +- .../bulkunassignmembersresponse.mdx | 2 +- docs/models/components/byokkey.mdx | 32 +- .../models/components/chatassistantimages.mdx | 2 +- .../chatassistantimagesimageurl.mdx | 2 +- .../components/chatassistantmessage.mdx | 20 +- docs/models/components/chataudiooutput.mdx | 8 +- docs/models/components/chatchoice.mdx | 8 +- docs/models/components/chatcontentaudio.mdx | 4 +- .../components/chatcontentaudioinputaudio.mdx | 4 +- .../components/chatcontentcachecontrol.mdx | 4 +- docs/models/components/chatcontentfile.mdx | 4 +- .../models/components/chatcontentfilefile.mdx | 6 +- docs/models/components/chatcontentimage.mdx | 4 +- .../components/chatcontentimageimageurl.mdx | 4 +- docs/models/components/chatcontenttext.mdx | 8 +- docs/models/components/chatcontentvideo.mdx | 4 +- .../components/chatcontentvideoinput.mdx | 4 +- docs/models/components/chatdebugoptions.mdx | 2 +- .../components/chatdevelopermessage.mdx | 8 +- ...hatdevelopermessageconfigurationupdate.mdx | 2 +- .../components/chatdynamicservertool.mdx | 4 +- .../components/chatformatgrammarconfig.mdx | 4 +- .../components/chatformatjsonobjectconfig.mdx | 2 +- .../components/chatformatjsonschemaconfig.mdx | 4 +- .../components/chatformatpythonconfig.mdx | 2 +- .../components/chatformattextconfig.mdx | 2 +- .../components/chatfunctiontoolfunction.mdx | 6 +- .../chatfunctiontoolfunctionfunction.mdx | 8 +- .../components/chatjsonschemaconfig.mdx | 8 +- .../models/components/chatnamedtoolchoice.mdx | 4 +- .../chatnamedtoolchoicefunction.mdx | 2 +- docs/models/components/chatrequest.mdx | 82 ++--- .../components/chatrequestreasoning.mdx | 4 +- docs/models/components/chatresult.mdx | 18 +- .../components/chatsearchmodelsservertool.mdx | 4 +- .../components/chatservertoolchoice.mdx | 2 +- docs/models/components/chatstreamchoice.mdx | 8 +- docs/models/components/chatstreamchunk.mdx | 20 +- .../components/chatstreamchunkerror.mdx | 6 +- .../components/chatstreamchunkmetadata.mdx | 4 +- docs/models/components/chatstreamdelta.mdx | 14 +- .../components/chatstreamingresponse.mdx | 2 +- docs/models/components/chatstreamoptions.mdx | 2 +- docs/models/components/chatstreamtoolcall.mdx | 8 +- .../components/chatstreamtoolcallfunction.mdx | 4 +- docs/models/components/chatsystemmessage.mdx | 8 +- .../chatsystemmessageconfigurationupdate.mdx | 2 +- docs/models/components/chattokenlogprob.mdx | 8 +- docs/models/components/chattokenlogprobs.mdx | 4 +- .../components/chattokenlogprobtoplogprob.mdx | 6 +- docs/models/components/chattoolcall.mdx | 6 +- .../components/chattoolcallfunction.mdx | 4 +- docs/models/components/chattoolmessage.mdx | 6 +- docs/models/components/chatusage.mdx | 18 +- .../chatusagecompletiontokensdetails.mdx | 8 +- .../chatusageprompttokensdetails.mdx | 8 +- docs/models/components/chatusermessage.mdx | 6 +- .../components/chatwebsearchshorthand.mdx | 26 +- docs/models/components/choice.mdx | 10 +- .../codeinterpretercallcodedeltaevent.mdx | 10 +- .../codeinterpretercallcodedoneevent.mdx | 10 +- .../codeinterpretercallcompletedevent.mdx | 8 +- .../codeinterpretercallinprogressevent.mdx | 8 +- .../codeinterpretercallinterpretingevent.mdx | 8 +- .../components/codeinterpreterfileoutput.mdx | 20 +- .../components/codeinterpreterimageoutput.mdx | 4 +- .../components/codeinterpreterlogsoutput.mdx | 4 +- .../components/codeinterpreterservertool.mdx | 4 +- .../models/components/codexlocalshelltool.mdx | 2 +- docs/models/components/compactionitem.mdx | 8 +- docs/models/components/compoundfilter.mdx | 4 +- .../components/computeruseservertool.mdx | 8 +- .../components/configurationupdateitem.mdx | 6 +- .../configurationupdatereasoning.mdx | 2 +- .../components/conflictresponseerrordata.mdx | 6 +- docs/models/components/containerauto.mdx | 6 +- .../components/containerautoenvironment.mdx | 6 +- docs/models/components/containerfile.mdx | 14 +- .../components/containerfilelistresponse.mdx | 10 +- .../containernetworkpolicyallowlist.mdx | 4 +- .../containernetworkpolicydisabled.mdx | 2 +- .../containerreferenceenvironment.mdx | 8 +- docs/models/components/contentcompaction.mdx | 8 +- .../components/contentencryptedcontent.mdx | 6 +- .../components/contentfilterbuiltinentry.mdx | 8 +- .../contentfilterbuiltinentryinput.mdx | 8 +- docs/models/components/contentfilterentry.mdx | 6 +- docs/models/components/contentimageurl.mdx | 4 +- .../components/contentimageurlimageurl.mdx | 2 +- .../components/contentpartaddedevent.mdx | 12 +- docs/models/components/contentpartaudio.mdx | 4 +- .../components/contentpartdoneevent.mdx | 12 +- docs/models/components/contentpartimage.mdx | 4 +- .../components/contentpartimageimageurl.mdx | 2 +- .../components/contentpartinputaudio.mdx | 4 +- .../components/contentpartinputfile.mdx | 4 +- .../components/contentpartinputvideo.mdx | 4 +- docs/models/components/contentpartvideo.mdx | 4 +- .../components/contentredactedthinking.mdx | 4 +- .../components/contentservertooluse.mdx | 10 +- docs/models/components/contenttext.mdx | 4 +- docs/models/components/contentthinking.mdx | 6 +- .../components/contenttoolreference.mdx | 4 +- docs/models/components/contenttoolresult.mdx | 10 +- docs/models/components/contenttooluse.mdx | 10 +- docs/models/components/contenttoplogprob.mdx | 6 +- .../components/contentwebsearchtoolresult.mdx | 8 +- .../contentwebsearchtoolresulterror.mdx | 4 +- .../components/contextcompactionitem.mdx | 8 +- .../components/contextcompressionplugin.mdx | 6 +- docs/models/components/contextmanagement.mdx | 2 +- docs/models/components/contradiction.mdx | 4 +- docs/models/components/costdetails.mdx | 8 +- .../components/createbyokkeyrequest.mdx | 26 +- .../components/createbyokkeyresponse.mdx | 2 +- .../components/createenduserrequest.mdx | 2 +- .../components/createguardrailrequest.mdx | 44 +-- .../components/createguardrailresponse.mdx | 2 +- .../models/components/createinternrequest.mdx | 12 +- .../createobservabilitydestinationrequest.mdx | 26 +- ...createobservabilitydestinationresponse.mdx | 2 +- .../createpresetfrominferenceresponse.mdx | 2 +- .../createprivateendpointrequest.mdx | 16 +- ...teendpointvalidationfailedresponsedata.mdx | 4 +- ...eendpointvalidationfailedresponseerror.mdx | 4 +- .../createscimgroupmappingrequest.mdx | 6 +- .../createscimgroupmappingresponse.mdx | 2 +- .../components/createscimsyncjobresponse.mdx | 2 +- .../components/createworkspacerequest.mdx | 24 +- .../components/createworkspaceresponse.mdx | 2 +- docs/models/components/customtool.mdx | 10 +- .../customtoolcallinputdeltaevent.mdx | 10 +- .../customtoolcallinputdoneevent.mdx | 10 +- docs/models/components/customtoolcallitem.mdx | 16 +- .../components/customtoolcalloutputitem.mdx | 8 +- ...stomtoolcalloutputitemoutputinputimage.mdx | 8 +- docs/models/components/dabenchmarkentry.mdx | 10 +- docs/models/components/datetimeservertool.mdx | 4 +- .../components/datetimeservertoolconfig.mdx | 2 +- docs/models/components/debugevent.mdx | 6 +- docs/models/components/debugeventdebug.mdx | 4 +- docs/models/components/debugeventtimings.mdx | 6 +- docs/models/components/decisions.mdx | 6 +- .../components/decisionschoiceanswer.mdx | 8 +- .../components/decisionschoicequestion.mdx | 6 +- .../models/components/decisionsnoulanswer.mdx | 4 +- .../components/decisionsnoulquestion.mdx | 6 +- .../decisionsnoulquestioncriteria.mdx | 4 +- docs/models/components/decisionsrequest.mdx | 14 +- docs/models/components/decisionsresponse.mdx | 10 +- .../components/decisionsresponseusage.mdx | 6 +- .../components/decisionsscoreanswer.mdx | 10 +- .../components/decisionsscorequestion.mdx | 6 +- docs/models/components/defaultparameters.mdx | 12 +- .../components/deletebyokkeyresponse.mdx | 2 +- .../components/deleteguardrailresponse.mdx | 2 +- .../models/components/deleteinternrequest.mdx | 2 +- .../components/deleteinternresponse.mdx | 2 +- ...deleteobservabilitydestinationresponse.mdx | 2 +- .../deleteprivateendpointresponse.mdx | 2 +- .../deleteprivateendpointresponsedata.mdx | 2 +- .../deletescimgroupmappingresponse.mdx | 2 +- .../deleteworkspacebudgetresponse.mdx | 2 +- .../components/deleteworkspaceresponse.mdx | 2 +- docs/models/components/easyinputmessage.mdx | 8 +- .../easyinputmessagecontentinputimage.mdx | 8 +- .../edgenetworktimeoutresponseerrordata.mdx | 6 +- .../components/editclearthinking20251015.mdx | 4 +- .../components/editcleartooluses20250919.mdx | 12 +- .../models/components/editcompact20260112.mdx | 8 +- docs/models/components/embeddings.mdx | 6 +- docs/models/components/endpointinfo.mdx | 6 +- docs/models/components/endpointsmetadata.mdx | 4 +- docs/models/components/enduser.mdx | 8 +- docs/models/components/enduserresponse.mdx | 2 +- docs/models/components/enumcapability.mdx | 4 +- docs/models/components/errorevent.mdx | 10 +- docs/models/components/failedmodel.mdx | 6 +- docs/models/components/filecitation.mdx | 8 +- docs/models/components/fileparserplugin.mdx | 6 +- docs/models/components/filepath.mdx | 6 +- .../components/filesearchservertool.mdx | 10 +- docs/models/components/filesservertool.mdx | 4 +- docs/models/components/filters.mdx | 6 +- .../components/forbiddenresponseerrordata.mdx | 6 +- docs/models/components/formatgrammar.mdx | 6 +- .../components/formatjsonobjectconfig.mdx | 2 +- .../components/formatjsonschemaconfig.mdx | 10 +- docs/models/components/formattext.mdx | 2 +- docs/models/components/formattextconfig.mdx | 2 +- docs/models/components/frameimage.mdx | 6 +- docs/models/components/frameimageimageurl.mdx | 2 +- .../components/freemodeldailyrequests.mdx | 6 +- .../components/functioncallargsdeltaevent.mdx | 10 +- .../components/functioncallargsdoneevent.mdx | 12 +- docs/models/components/functioncallitem.mdx | 20 +- .../functioncallitemsubagentitem.mdx | 4 +- .../components/functioncalloutputitem.mdx | 10 +- ...functioncalloutputitemoutputinputimage.mdx | 8 +- .../components/fusionanalysisresult.mdx | 10 +- .../fusioncallanalysiscompletedevent.mdx | 10 +- .../fusioncallanalysisinprogressevent.mdx | 12 +- .../components/fusioncallcompletedevent.mdx | 8 +- .../components/fusioncallinprogressevent.mdx | 8 +- .../components/fusioncallpaneladdedevent.mdx | 10 +- .../fusioncallpanelcompletedevent.mdx | 12 +- .../components/fusioncallpaneldeltaevent.mdx | 12 +- .../components/fusioncallpanelfailedevent.mdx | 14 +- .../fusioncallpanelreasoningdeltaevent.mdx | 12 +- docs/models/components/fusionplugin.mdx | 14 +- docs/models/components/fusionplugintool.mdx | 4 +- .../components/fusionservertoolconfig.mdx | 16 +- .../fusionservertoolconfigreasoning.mdx | 4 +- .../components/fusionservertoolconfigtool.mdx | 4 +- .../components/fusionservertoolopenrouter.mdx | 4 +- docs/models/components/fusionsource.mdx | 4 +- .../gatewaytimeoutresponseerrordata.mdx | 6 +- .../components/generationcontentdata.mdx | 6 +- .../generationcontentdataoutput.mdx | 4 +- .../components/generationcontenterror.mdx | 10 +- .../generationcontenterrorattempt.mdx | 8 +- .../components/generationcontentresponse.mdx | 2 +- docs/models/components/generationresponse.mdx | 2 +- .../components/generationresponsedata.mdx | 90 +++--- docs/models/components/getbyokkeyresponse.mdx | 2 +- .../components/getguardrailresponse.mdx | 2 +- .../getobservabilitydestinationresponse.mdx | 2 +- docs/models/components/getpresetresponse.mdx | 2 +- .../components/getpresetversionresponse.mdx | 2 +- .../getscimgroupmappingresponse.mdx | 2 +- .../components/getscimsyncjobresponse.mdx | 2 +- docs/models/components/gettoolresponse.mdx | 2 +- .../components/getworkspacebudgetresponse.mdx | 4 +- .../components/getworkspaceresponse.mdx | 2 +- .../components/goneresponseerrordata.mdx | 6 +- docs/models/components/guardrail.mdx | 50 +-- docs/models/components/image.mdx | 4 +- docs/models/components/imageendpoint.mdx | 14 +- .../components/imagegencallcompletedevent.mdx | 8 +- .../imagegencallgeneratingevent.mdx | 8 +- .../imagegencallinprogressevent.mdx | 8 +- .../imagegencallpartialimageevent.mdx | 12 +- .../components/imagegencompletedevent.mdx | 10 +- docs/models/components/imagegeneration.mdx | 6 +- .../imagegenerationproviderpreferences.mdx | 12 +- ...gegenerationproviderpreferencesoptions.mdx | 292 +++++++++--------- .../components/imagegenerationrequest.mdx | 34 +- .../components/imagegenerationresponse.mdx | 6 +- .../imagegenerationresponsedata.mdx | 4 +- .../components/imagegenerationservertool.mdx | 22 +- .../imagegenerationservertoolconfig.mdx | 4 +- .../imagegenerationservertoolopenrouter.mdx | 4 +- .../components/imagegenerationusage.mdx | 26 +- ...generationusagecompletiontokensdetails.mdx | 6 +- ...magegenerationusageprompttokensdetails.mdx | 10 +- .../imagegenerationusageservertooluse.mdx | 6 +- .../components/imagegenpartialimageevent.mdx | 6 +- .../components/imagegenstreamerrorevent.mdx | 4 +- .../imagegenstreamerroreventerror.mdx | 8 +- .../components/imagegentextchunkevent.mdx | 6 +- .../components/imagemodelarchitecture.mdx | 4 +- .../imagemodelendpointsresponse.mdx | 4 +- docs/models/components/imagemodellistitem.mdx | 16 +- .../components/imagemodelslistresponse.mdx | 2 +- docs/models/components/imagepricingentry.mdx | 8 +- .../components/imagestreamingresponse.mdx | 2 +- docs/models/components/incompletedetails.mdx | 2 +- docs/models/components/input1.mdx | 2 +- docs/models/components/input2.mdx | 2 +- docs/models/components/inputaudio.mdx | 4 +- .../components/inputaudioinputaudio.mdx | 4 +- docs/models/components/inputfile.mdx | 10 +- docs/models/components/inputimage.mdx | 8 +- docs/models/components/inputimagemask.mdx | 4 +- docs/models/components/inputmessageitem.mdx | 8 +- .../inputmessageitemcontentinputimage.mdx | 8 +- docs/models/components/inputschema.mdx | 8 +- docs/models/components/inputsmessage.mdx | 12 +- docs/models/components/inputsreasoning.mdx | 16 +- docs/models/components/inputtext.mdx | 6 +- docs/models/components/inputtokensdetails.mdx | 4 +- docs/models/components/inputvideo.mdx | 6 +- docs/models/components/intern.mdx | 28 +- .../internalserverresponseerrordata.mdx | 6 +- .../components/internchatassistantmessage.mdx | 6 +- docs/models/components/internchatchoice.mdx | 6 +- .../components/internchatcompletionchunk.mdx | 16 +- .../internchatcompletionrequest.mdx | 10 +- docs/models/components/internchatdelta.mdx | 8 +- .../components/internchatdevelopermessage.mdx | 4 +- .../components/internchatechoedtoolcall.mdx | 4 +- .../internchatechoedtoolcallfunction.mdx | 4 +- docs/models/components/internchaterror.mdx | 6 +- .../components/internchaterrormetadata.mdx | 4 +- .../internchatprompttokensdetails.mdx | 2 +- .../components/internchatsteeredresponse.mdx | 4 +- .../components/internchatstreamerror.mdx | 6 +- .../internchatstreamingresponse.mdx | 2 +- .../components/internchatsystemmessage.mdx | 4 +- docs/models/components/internchattextpart.mdx | 4 +- docs/models/components/internchattoolcall.mdx | 8 +- .../components/internchattoolcallfunction.mdx | 4 +- .../components/internchattoolmessage.mdx | 6 +- docs/models/components/internchatusage.mdx | 10 +- .../components/internchatusermessage.mdx | 4 +- docs/models/components/interndaemonaccess.mdx | 4 +- .../interninvokeacceptedresponse.mdx | 4 +- .../models/components/interninvokerequest.mdx | 4 +- .../components/internlifecycleerrorerror.mdx | 6 +- .../internlifecycleerrormetadata.mdx | 4 +- docs/models/components/internlistresponse.mdx | 6 +- docs/models/components/itemreferenceitem.mdx | 4 +- docs/models/components/jevrouterplugin.mdx | 10 +- docs/models/components/keepall.mdx | 2 +- docs/models/components/key.mdx | 14 +- docs/models/components/keyassignment.mdx | 14 +- .../components/legacychatcontentvideo.mdx | 6 +- .../legacychatcontentvideoinput.mdx | 4 +- .../components/legacywebsearchservertool.mdx | 18 +- .../components/listbyokkeysresponse.mdx | 4 +- .../components/listendpointsresponse.mdx | 12 +- .../components/listendusersresponse.mdx | 4 +- .../components/listguardrailsresponse.mdx | 4 +- .../components/listkeyassignmentsresponse.mdx | 4 +- .../listmemberassignmentsresponse.mdx | 4 +- .../listobservabilitydestinationsresponse.mdx | 4 +- .../models/components/listpresetsresponse.mdx | 4 +- .../components/listpresetversionsresponse.mdx | 4 +- .../listprivateendpointsresponse.mdx | 2 +- .../listscimgroupmappingsresponse.mdx | 4 +- .../components/listscimgroupsresponse.mdx | 4 +- docs/models/components/listtoolsresponse.mdx | 6 +- .../components/listtoolsresponselinks.mdx | 2 +- .../listworkspacebudgetsresponse.mdx | 4 +- .../listworkspacemembersresponse.mdx | 4 +- .../components/listworkspacesresponse.mdx | 4 +- docs/models/components/localshellcallitem.mdx | 10 +- .../components/localshellcallitemaction.mdx | 12 +- .../components/localshellcalloutputitem.mdx | 8 +- docs/models/components/logprob.mdx | 8 +- docs/models/components/logprobs.mdx | 4 +- docs/models/components/logprobscontent.mdx | 8 +- .../components/managedprivateendpoint.mdx | 18 +- .../managedprivateendpointresponse.mdx | 2 +- docs/models/components/maxprice.mdx | 10 +- .../components/mcpapprovalrequestitem.mdx | 10 +- .../components/mcpapprovalresponseitem.mdx | 10 +- docs/models/components/mcpcallitem.mdx | 14 +- docs/models/components/mcphttperror.mdx | 6 +- docs/models/components/mcplisttoolsitem.mdx | 10 +- .../components/mcplisttoolsitemtool.mdx | 8 +- docs/models/components/mcpprotocolerror.mdx | 6 +- docs/models/components/mcpservertool.mdx | 18 +- .../components/mcptoolexecutionerror.mdx | 4 +- docs/models/components/memberassignment.mdx | 12 +- docs/models/components/message.mdx | 16 +- .../messagesadvisortoolresultblock.mdx | 6 +- .../messagesbashtoolresultblock.mdx | 10 +- .../messagesbashtoolresultblockfile.mdx | 12 +- .../components/messagesfallbackparam.mdx | 4 +- .../components/messagesmessageparam.mdx | 8 +- .../components/messagesoutputconfig.mdx | 6 +- .../components/messagesoutputconfigformat.mdx | 4 +- docs/models/components/messagesrequest.mdx | 54 ++-- .../components/messagesrequestmetadata.mdx | 2 +- .../models/components/messagesrequesttool.mdx | 4 +- .../messagessearchmodelsservertool.mdx | 4 +- .../messagesshelltoolresultblock.mdx | 10 +- .../messagesshelltoolresultblockfile.mdx | 12 +- .../components/messagestooladditionblock.mdx | 6 +- ...stooladditionblocktoolmcptoolreference.mdx | 6 +- ...oladditionblocktoolmcptoolsetreference.mdx | 4 +- ...agestooladditionblocktooltoolreference.mdx | 4 +- .../components/messagestoolremovalblock.mdx | 6 +- ...estoolremovalblocktoolmcptoolreference.mdx | 6 +- ...oolremovalblocktoolmcptoolsetreference.mdx | 4 +- ...sagestoolremovalblocktooltoolreference.mdx | 4 +- docs/models/components/mismatchbehavior.mdx | 2 +- docs/models/components/model.mdx | 40 +-- docs/models/components/modelaliastarget.mdx | 4 +- docs/models/components/modelarchitecture.mdx | 10 +- docs/models/components/modelbenchmarks.mdx | 4 +- docs/models/components/modellinks.mdx | 2 +- docs/models/components/modelreasoning.mdx | 10 +- docs/models/components/modelresponse.mdx | 2 +- .../models/components/modelscountresponse.mdx | 2 +- .../components/modelscountresponsedata.mdx | 2 +- docs/models/components/modelslistresponse.mdx | 6 +- .../components/modelslistresponselinks.mdx | 2 +- docs/models/components/moderationplugin.mdx | 2 +- docs/models/components/multimodalmedia.mdx | 4 +- .../components/namespacefunctiontool.mdx | 18 +- docs/models/components/namespacetool.mdx | 8 +- docs/models/components/nativesupport.mdx | 6 +- docs/models/components/nativetools.mdx | 2 +- docs/models/components/never.mdx | 2 +- .../components/notfoundresponseerrordata.mdx | 6 +- docs/models/components/oauthjwks.mdx | 2 +- .../observabilityarizedestination.mdx | 32 +- .../observabilityarizedestinationconfig.mdx | 10 +- .../observabilitybraintrustdestination.mdx | 32 +- ...servabilitybraintrustdestinationconfig.mdx | 8 +- .../observabilityclickhousedestination.mdx | 32 +- ...servabilityclickhousedestinationconfig.mdx | 14 +- .../observabilitydatadogdestination.mdx | 32 +- .../observabilitydatadogdestinationconfig.mdx | 8 +- .../observabilityfilterrulegroup.mdx | 4 +- .../observabilityfilterrulesconfig.mdx | 4 +- ...observabilityfilterrulesconfignullable.mdx | 4 +- .../observabilitygrafanadestination.mdx | 32 +- .../observabilitygrafanadestinationconfig.mdx | 8 +- .../observabilitylangfusedestination.mdx | 32 +- ...observabilitylangfusedestinationconfig.mdx | 8 +- .../observabilitylangsmithdestination.mdx | 32 +- ...bservabilitylangsmithdestinationconfig.mdx | 10 +- .../observabilitynewrelicdestination.mdx | 32 +- ...observabilitynewrelicdestinationconfig.mdx | 6 +- .../observabilityopikdestination.mdx | 32 +- .../observabilityopikdestinationconfig.mdx | 8 +- .../observabilityotelcollectordestination.mdx | 32 +- ...vabilityotelcollectordestinationconfig.mdx | 4 +- .../observabilityposthogdestination.mdx | 32 +- .../observabilityposthogdestinationconfig.mdx | 6 +- .../observabilityrampdestination.mdx | 32 +- .../observabilityrampdestinationconfig.mdx | 6 +- .../components/observabilitys3destination.mdx | 32 +- .../observabilitys3destinationconfig.mdx | 18 +- .../observabilitysentrydestination.mdx | 32 +- .../observabilitysentrydestinationconfig.mdx | 6 +- .../observabilitysnowflakedestination.mdx | 32 +- ...bservabilitysnowflakedestinationconfig.mdx | 16 +- .../observabilityweavedestination.mdx | 32 +- .../observabilityweavedestinationconfig.mdx | 10 +- .../observabilitywebhookdestination.mdx | 32 +- .../observabilitywebhookdestinationconfig.mdx | 6 +- docs/models/components/openaifile.mdx | 16 +- docs/models/components/openaifiledeleted.mdx | 8 +- docs/models/components/openaifilelist.mdx | 12 +- .../openairesponsecustomtoolcall.mdx | 14 +- .../openairesponsecustomtoolcalloutput.mdx | 8 +- .../openairesponsefunctiontoolcall.mdx | 20 +- .../openairesponsefunctiontoolcalloutput.mdx | 10 +- ...airesponsefunctiontoolcallsubagentitem.mdx | 4 +- .../openairesponseinputmessageitem.mdx | 8 +- .../openairesponsesrefusalcontent.mdx | 4 +- .../components/openairesponsestoolchoice.mdx | 2 +- .../openairesponsestoolchoiceapplypatch.mdx | 2 +- .../openairesponsestoolchoicefunction.mdx | 4 +- .../openairesponsestoolchoiceshell.mdx | 2 +- .../components/openresponsescreatedevent.mdx | 6 +- .../components/openresponseserrorfield.mdx | 6 +- .../components/openresponseserrormetadata.mdx | 2 +- .../openresponseserrormetadataalignment.mdx | 4 +- .../openresponsesinprogressevent.mdx | 6 +- .../models/components/openresponsesresult.mdx | 76 ++--- .../openresponsesresulttoolfunction.mdx | 14 +- docs/models/components/openrouterfile.mdx | 16 +- .../components/openrouterfiledeleted.mdx | 6 +- docs/models/components/openrouterfilelist.mdx | 12 +- docs/models/components/openroutermetadata.mdx | 22 +- .../openrouterwebsearchservertool.mdx | 4 +- .../components/oranthropicbashtoolresult.mdx | 10 +- .../oranthropicbashtoolresultfile.mdx | 12 +- .../oranthropicservertooluseblock.mdx | 10 +- .../components/oranthropicshelltoolresult.mdx | 10 +- .../oranthropicshelltoolresultfile.mdx | 12 +- .../components/organizationsettings.mdx | 4 +- docs/models/components/outcomeexit.mdx | 6 +- docs/models/components/outcometimeout.mdx | 4 +- .../outputadvisorservertoolitem.mdx | 16 +- .../components/outputapplypatchcallitem.mdx | 10 +- .../outputapplypatchservertoolitem.mdx | 12 +- .../components/outputbashservertoolitem.mdx | 24 +- .../outputbashservertoolitemfile.mdx | 12 +- .../outputbrowseruseservertoolitem.mdx | 10 +- .../outputcodeinterpretercallitem.mdx | 14 +- .../outputcodeinterpreterservertoolitem.mdx | 16 +- .../components/outputcomputercallitem.mdx | 12 +- .../components/outputcustomtoolcallitem.mdx | 16 +- docs/models/components/outputdatetimeitem.mdx | 12 +- .../components/outputfilesearchcallitem.mdx | 8 +- .../outputfilesearchservertoolitem.mdx | 8 +- .../components/outputfilesservertoolitem.mdx | 20 +- .../components/outputfunctioncallitem.mdx | 20 +- .../outputfunctioncallitemsubagentitem.mdx | 4 +- .../components/outputfusionservertoolitem.mdx | 18 +- .../outputfusionservertoolitemresponse.mdx | 4 +- .../outputimagegenerationcallitem.mdx | 10 +- .../outputimagegenerationservertoolitem.mdx | 18 +- .../components/outputitemapplypatchcall.mdx | 12 +- .../outputitemcodeinterpretercall.mdx | 14 +- .../components/outputitemcustomtoolcall.mdx | 16 +- .../components/outputitemfilesearchcall.mdx | 8 +- .../components/outputitemfunctioncall.mdx | 16 +- .../outputitemimagegenerationcall.mdx | 8 +- .../models/components/outputitemreasoning.mdx | 12 +- .../components/outputitemwebsearchcall.mdx | 10 +- ...utputitemwebsearchcallactionfindinpage.mdx | 6 +- .../outputitemwebsearchcallactionopenpage.mdx | 4 +- .../outputitemwebsearchcallactionsearch.mdx | 8 +- .../components/outputmcpservertoolitem.mdx | 10 +- .../components/outputmemoryservertoolitem.mdx | 12 +- docs/models/components/outputmessage.mdx | 12 +- docs/models/components/outputmessageitem.mdx | 12 +- .../models/components/outputreasoningitem.mdx | 16 +- .../outputsearchmodelsservertoolitem.mdx | 12 +- .../models/components/outputshellcallitem.mdx | 12 +- .../components/outputshellcallitemaction.mdx | 6 +- .../components/outputshellcalloutputitem.mdx | 18 +- .../outputshellcalloutputitemfile.mdx | 12 +- .../components/outputshellservertoolitem.mdx | 20 +- .../outputshellservertoolitemaction.mdx | 6 +- .../outputshellservertoolitemfile.mdx | 12 +- .../outputsubagentservertoolitem.mdx | 22 +- .../outputtexteditorservertoolitem.mdx | 10 +- .../models/components/outputtokensdetails.mdx | 2 +- .../components/outputtoolsearchcallitem.mdx | 12 +- .../outputtoolsearchservertoolitem.mdx | 10 +- .../outputwebfetchservertoolitem.mdx | 16 +- .../components/outputwebsearchcallitem.mdx | 10 +- ...utputwebsearchcallitemactionfindinpage.mdx | 6 +- .../outputwebsearchcallitemactionopenpage.mdx | 4 +- .../outputwebsearchcallitemactionsearch.mdx | 8 +- .../outputwebsearchservertoolitem.mdx | 10 +- .../outputwebsearchservertoolitemaction.mdx | 6 +- .../outputwebsearchservertoolitemsource.mdx | 4 +- docs/models/components/paretorouterplugin.mdx | 10 +- docs/models/components/partialcoverage.mdx | 4 +- .../payloadtoolargeresponseerrordata.mdx | 6 +- .../paymentrequiredresponseerrordata.mdx | 6 +- docs/models/components/pdfparseroptions.mdx | 2 +- docs/models/components/pendingsafetycheck.mdx | 6 +- .../components/percentilelatencycutoffs.mdx | 8 +- docs/models/components/percentilestats.mdx | 8 +- .../percentilethroughputcutoffs.mdx | 8 +- .../components/perflast30mbyworkload.mdx | 18 +- docs/models/components/perrequestlimits.mdx | 4 +- docs/models/components/pipelinestage.mdx | 14 +- docs/models/components/prediction.mdx | 4 +- .../components/predictioncontenttext.mdx | 4 +- docs/models/components/preset.mdx | 22 +- .../components/presetdesignatedversion.mdx | 16 +- .../presetwithdesignatedversion.mdx | 24 +- .../preview20250311websearchservertool.mdx | 18 +- .../components/previewwebsearchservertool.mdx | 18 +- .../previewwebsearchuserlocation.mdx | 10 +- docs/models/components/pricing.mdx | 32 +- docs/models/components/pricingoverride.mdx | 22 +- docs/models/components/privateendpoint.mdx | 24 +- .../components/privateendpointactivation.mdx | 2 +- .../components/privateendpointcheck.mdx | 12 +- .../components/privateendpointpricing.mdx | 4 +- .../components/privateendpointresponse.mdx | 2 +- .../components/privateendpointsummary.mdx | 14 +- .../components/privateendpointvalidation.mdx | 4 +- .../privateendpointvalidationnullable.mdx | 4 +- .../privateendpointvalidationresponse.mdx | 2 +- docs/models/components/progress.mdx | 6 +- .../components/promptcachebreakpoint.mdx | 2 +- docs/models/components/promptcacheoptions.mdx | 4 +- docs/models/components/provideroptions.mdx | 292 +++++++++--------- .../provideroverloadedresponseerrordata.mdx | 6 +- .../models/components/providerpreferences.mdx | 28 +- docs/models/components/providerresponse.mdx | 16 +- docs/models/components/providersortconfig.mdx | 4 +- .../components/provisioninternresponse.mdx | 2 +- docs/models/components/publicendpoint.mdx | 48 +-- docs/models/components/publicpricing.mdx | 32 +- docs/models/components/rangecapability.mdx | 6 +- docs/models/components/rankingoptions.mdx | 4 +- docs/models/components/rankingsdailyitem.mdx | 6 +- docs/models/components/rankingsdailymeta.mdx | 8 +- .../components/rankingsdailyresponse.mdx | 4 +- docs/models/components/reasoningconfig.mdx | 12 +- .../models/components/reasoningdeltaevent.mdx | 12 +- .../components/reasoningdetailencrypted.mdx | 10 +- .../reasoningdetailservertoolcall.mdx | 16 +- .../components/reasoningdetailsummary.mdx | 10 +- .../models/components/reasoningdetailtext.mdx | 12 +- docs/models/components/reasoningdoneevent.mdx | 12 +- docs/models/components/reasoningitem.mdx | 16 +- .../reasoningsummarypartaddedevent.mdx | 12 +- .../reasoningsummarypartdoneevent.mdx | 12 +- .../components/reasoningsummarytext.mdx | 4 +- .../reasoningsummarytextdeltaevent.mdx | 12 +- .../reasoningsummarytextdoneevent.mdx | 12 +- .../components/reasoningtextcontent.mdx | 4 +- docs/models/components/refusal.mdx | 8 +- docs/models/components/refusaldeltaevent.mdx | 12 +- docs/models/components/refusaldoneevent.mdx | 12 +- docs/models/components/refusaltoplogprob.mdx | 6 +- docs/models/components/request.mdx | 4 +- .../requesttimeoutresponseerrordata.mdx | 6 +- docs/models/components/requireapproval.mdx | 4 +- docs/models/components/rerank.mdx | 6 +- .../components/responsehealingplugin.mdx | 4 +- docs/models/components/responseoutputtext.mdx | 8 +- .../responseoutputtexttoplogprob.mdx | 6 +- docs/models/components/responsesrequest.mdx | 78 ++--- .../responsesrequesttoolfunction.mdx | 14 +- .../components/responsesstreamingresponse.mdx | 2 +- docs/models/components/result.mdx | 8 +- docs/models/components/resulterror.mdx | 8 +- docs/models/components/routerattempt.mdx | 6 +- docs/models/components/routerparams.mdx | 8 +- docs/models/components/rule.mdx | 6 +- docs/models/components/scimgroup.mdx | 12 +- docs/models/components/scimgroupmapping.mdx | 14 +- docs/models/components/scimsyncjob.mdx | 16 +- .../searchmodelsservertoolconfig.mdx | 2 +- .../searchmodelsservertoolopenrouter.mdx | 4 +- docs/models/components/security.mdx | 2 +- docs/models/components/servertool.mdx | 30 +- docs/models/components/servertooldetails.mdx | 30 +- docs/models/components/servertoolengine.mdx | 18 +- .../models/components/servertoolinputname.mdx | 6 +- .../components/servertoolnativemodel.mdx | 4 +- .../components/servertoolnativesupport.mdx | 4 +- .../components/servertooloutputname.mdx | 6 +- docs/models/components/servertoolprice.mdx | 8 +- .../components/servertoolusedetails.mdx | 6 +- .../serviceunavailableresponseerrordata.mdx | 6 +- docs/models/components/sessioncostitem.mdx | 10 +- docs/models/components/sessioncostmeta.mdx | 8 +- .../models/components/sessioncostresponse.mdx | 4 +- docs/models/components/shellcallitem.mdx | 14 +- .../models/components/shellcallitemaction.mdx | 6 +- .../components/shellcalloutputcontent.mdx | 8 +- .../models/components/shellcalloutputitem.mdx | 18 +- .../components/shellcalloutputitemfile.mdx | 12 +- docs/models/components/shellservertool.mdx | 2 +- .../components/shellservertoolconfig.mdx | 4 +- .../components/shellservertoolopenrouter.mdx | 4 +- .../components/signinterndaemonrequest.mdx | 2 +- .../components/signinterndaemonresponse.mdx | 6 +- docs/models/components/sourcecontent.mdx | 4 +- .../components/speechinputreferenceaudio.mdx | 4 +- .../speechinputreferenceaudioinput.mdx | 6 +- .../components/speechinputreferenceimage.mdx | 4 +- .../speechinputreferenceimageinput.mdx | 2 +- .../components/speechinputreferencetext.mdx | 4 +- docs/models/components/speechrequest.mdx | 22 +- .../components/speechrequestprovider.mdx | 6 +- docs/models/components/speechturn.mdx | 6 +- docs/models/components/stance.mdx | 4 +- .../stopservertoolswhenfinishreasonis.mdx | 4 +- .../stopservertoolswhenhastoolcall.mdx | 4 +- .../components/stopservertoolswhenmaxcost.mdx | 4 +- .../stopservertoolswhenmaxtokensused.mdx | 4 +- .../stopservertoolswhenstepcountis.mdx | 4 +- .../components/storedprompttemplate.mdx | 4 +- .../streameventsresponsecompleted.mdx | 6 +- .../components/streameventsresponsefailed.mdx | 6 +- .../streameventsresponseincomplete.mdx | 6 +- .../streameventsresponseoutputitemadded.mdx | 8 +- .../streameventsresponseoutputitemdone.mdx | 8 +- docs/models/components/streamlogprob.mdx | 8 +- .../components/streamlogprobtoplogprob.mdx | 6 +- docs/models/components/stt.mdx | 6 +- docs/models/components/sttentity.mdx | 8 +- .../models/components/sttinlineinputaudio.mdx | 4 +- docs/models/components/sttrequest.mdx | 24 +- docs/models/components/sttrequestprovider.mdx | 6 +- docs/models/components/sttresponse.mdx | 20 +- docs/models/components/sttsegment.mdx | 26 +- docs/models/components/stturlinputaudio.mdx | 4 +- docs/models/components/sttusage.mdx | 10 +- docs/models/components/sttword.mdx | 16 +- docs/models/components/subagentnestedtool.mdx | 6 +- docs/models/components/subagentreasoning.mdx | 4 +- .../components/subagentservertoolconfig.mdx | 20 +- .../subagentservertoolopenrouter.mdx | 4 +- .../submitgenerationfeedbackrequest.mdx | 6 +- .../submitgenerationfeedbackresponse.mdx | 2 +- .../submitgenerationfeedbackresponsedata.mdx | 2 +- .../components/suspendinternresponse.mdx | 2 +- .../components/switchyardrouterplugin.mdx | 6 +- docs/models/components/taskbudget.mdx | 6 +- .../components/taskclassificationitem.mdx | 16 +- .../taskclassificationmacrocategory.mdx | 8 +- .../components/taskclassificationmodel.mdx | 6 +- .../components/taskclassificationresponse.mdx | 2 +- .../taskclassificationresponsedata.mdx | 8 +- docs/models/components/textdeltaevent.mdx | 14 +- docs/models/components/textdoneevent.mdx | 14 +- docs/models/components/textextendedconfig.mdx | 4 +- docs/models/components/textgeneration.mdx | 6 +- docs/models/components/thinkingadaptive.mdx | 6 +- .../components/thinkingbetweentools.mdx | 2 +- docs/models/components/thinkingdisabled.mdx | 2 +- docs/models/components/thinkingenabled.mdx | 8 +- .../components/tokenexchangerequest.mdx | 12 +- .../components/tokenexchangeresponse.mdx | 10 +- .../models/components/tooladvisor20260301.mdx | 16 +- docs/models/components/toolbash20250124.mdx | 6 +- docs/models/components/toolcall.mdx | 8 +- docs/models/components/toolchoiceallowed.mdx | 6 +- docs/models/components/toolchoiceany.mdx | 4 +- docs/models/components/toolchoiceauto.mdx | 4 +- docs/models/components/toolchoicenone.mdx | 2 +- docs/models/components/toolchoicesupport.mdx | 8 +- docs/models/components/toolchoicetool.mdx | 6 +- docs/models/components/toolcustom.mdx | 14 +- docs/models/components/toolsearchcallitem.mdx | 12 +- .../components/toolsearchoutputitem.mdx | 12 +- .../components/toolsearchoutputitemtool.mdx | 4 +- .../toolsearchoutputitemtoolfunction.mdx | 14 +- .../components/toolsearchservertool.mdx | 4 +- .../components/toolsearchservertoolconfig.mdx | 2 +- .../components/tooltexteditor20250124.mdx | 6 +- .../components/toolwebsearch20250305.mdx | 14 +- .../components/toolwebsearch20260209.mdx | 16 +- .../toomanyrequestsresponseerrordata.mdx | 6 +- docs/models/components/topproviderinfo.mdx | 6 +- docs/models/components/tournamentstats.mdx | 10 +- docs/models/components/traceconfig.mdx | 12 +- docs/models/components/triggerinputtokens.mdx | 4 +- docs/models/components/tts.mdx | 6 +- .../unauthorizedresponseerrordata.mdx | 6 +- .../components/unifiedbenchmarkpricing.mdx | 4 +- .../components/unifiedbenchmarksaaitem.mdx | 14 +- .../components/unifiedbenchmarksdaitem.mdx | 20 +- .../components/unifiedbenchmarksmeta.mdx | 14 +- .../components/unifiedbenchmarksoritem.mdx | 18 +- .../components/unifiedbenchmarksresponse.mdx | 4 +- .../unifiedbenchmarkssearchitem.mdx | 26 +- .../unifiedbenchmarkssearchrunconfig.mdx | 6 +- docs/models/components/uniqueinsight.mdx | 4 +- docs/models/components/unknown.mdx | 6 +- .../unprocessableentityresponseerrordata.mdx | 6 +- .../components/updatebyokkeyrequest.mdx | 22 +- .../components/updatebyokkeyresponse.mdx | 2 +- .../components/updateenduserrequest.mdx | 2 +- .../components/updateguardrailrequest.mdx | 42 +-- .../components/updateguardrailresponse.mdx | 2 +- .../models/components/updateinternrequest.mdx | 8 +- .../updateobservabilitydestinationrequest.mdx | 22 +- ...updateobservabilitydestinationresponse.mdx | 2 +- .../updateorganizationsettingsrequest.mdx | 2 +- .../updateprivateendpointpricingrequest.mdx | 2 +- .../updateprivateendpointrequest.mdx | 8 +- .../updatescimgroupmappingrequest.mdx | 2 +- .../updatescimgroupmappingresponse.mdx | 2 +- .../components/updateworkspacerequest.mdx | 24 +- .../components/updateworkspaceresponse.mdx | 2 +- docs/models/components/upscalefactor.mdx | 4 +- .../upsertworkspacebudgetrequest.mdx | 4 +- .../upsertworkspacebudgetresponse.mdx | 4 +- docs/models/components/upstream.mdx | 4 +- docs/models/components/urlcitation.mdx | 12 +- docs/models/components/usage.mdx | 18 +- docs/models/components/usagecostdetails.mdx | 8 +- docs/models/components/userlocation.mdx | 10 +- .../validateprivateendpointrequest.mdx | 2 +- .../components/vaulteffectivesecret.mdx | 10 +- .../vaulteffectivesecretlistresponse.mdx | 4 +- docs/models/components/vaultsecret.mdx | 8 +- .../components/vaultsecretcopyrequest.mdx | 2 +- .../components/vaultsecretcopyresponse.mdx | 2 +- .../components/vaultsecretlistresponse.mdx | 4 +- .../models/components/vaultsecretresponse.mdx | 2 +- .../components/vaultsecretwriterequest.mdx | 4 +- docs/models/components/videogeneration.mdx | 6 +- .../components/videogenerationrequest.mdx | 36 +-- .../videogenerationrequestoptions.mdx | 292 +++++++++--------- .../videogenerationrequestprovider.mdx | 2 +- .../components/videogenerationresponse.mdx | 14 +- .../components/videogenerationusage.mdx | 4 +- docs/models/components/videomodel.mdx | 34 +- .../components/videomodelslistresponse.mdx | 2 +- docs/models/components/videourl.mdx | 2 +- docs/models/components/webfetchplugin.mdx | 10 +- docs/models/components/webfetchservertool.mdx | 4 +- .../components/webfetchservertoolconfig.mdx | 10 +- .../websearchcallcompletedevent.mdx | 8 +- .../websearchcallinprogressevent.mdx | 8 +- .../websearchcallsearchingevent.mdx | 8 +- docs/models/components/websearchcitation.mdx | 8 +- docs/models/components/websearchconfig.mdx | 22 +- .../components/websearchdomainfilter.mdx | 6 +- docs/models/components/websearchplugin.mdx | 22 +- .../models/components/websearchservertool.mdx | 18 +- .../components/websearchservertoolconfig.mdx | 22 +- .../websearchservertoolopenrouter.mdx | 4 +- docs/models/components/websearchsource.mdx | 4 +- .../components/websearchuserlocation.mdx | 10 +- .../websearchuserlocationservertool.mdx | 10 +- docs/models/components/workspace.mdx | 36 +-- docs/models/components/workspacebudget.mdx | 12 +- docs/models/components/workspacemember.mdx | 10 +- docs/models/components/xsearchoptions.mdx | 12 +- .../activateprivateendpointrequest.mdx | 2 +- .../bulkaddworkspacemembersrequest.mdx | 4 +- .../bulkassignkeystoguardrailrequest.mdx | 4 +- .../bulkassignmemberstoguardrailrequest.mdx | 4 +- .../bulkremoveworkspacemembersrequest.mdx | 4 +- .../bulkunassignkeysfromguardrailrequest.mdx | 4 +- ...ulkunassignmembersfromguardrailrequest.mdx | 4 +- .../operations/classifierdimensions.mdx | 6 +- docs/models/operations/classifierfilters.mdx | 4 +- .../operations/classifierfiltersfilter.mdx | 6 +- docs/models/operations/contentimageurl.mdx | 4 +- docs/models/operations/contenttext.mdx | 4 +- .../copyvaultsecretstointernrequest.mdx | 4 +- ...createaudiotranscriptionsmultipartfile.mdx | 4 +- ...ateaudiotranscriptionsmultipartrequest.mdx | 26 +- .../operations/createauthkeyscodedata.mdx | 6 +- .../operations/createauthkeyscoderequest.mdx | 16 +- .../operations/createauthkeyscoderesponse.mdx | 2 +- .../operations/createembeddingsdata.mdx | 6 +- .../operations/createembeddingsrequest.mdx | 18 +- .../createembeddingsresponsebody.mdx | 10 +- .../operations/createembeddingsusage.mdx | 12 +- .../createinternchatcompletionrequest.mdx | 4 +- .../createinternchatcompletionresponse.mdx | 4 +- .../models/operations/createinternrequest.mdx | 4 +- docs/models/operations/createkeysdata.mdx | 46 +-- docs/models/operations/createkeysrequest.mdx | 16 +- docs/models/operations/createkeysresponse.mdx | 4 +- .../createpresetschatcompletionsrequest.mdx | 4 +- .../createpresetsmessagesrequest.mdx | 4 +- .../createpresetsresponsesrequest.mdx | 4 +- .../createprivateendpointrequest.mdx | 4 +- .../models/operations/creatererankrequest.mdx | 16 +- .../operations/creatererankresponsebody.mdx | 10 +- docs/models/operations/creatererankusage.mdx | 6 +- .../operations/createresponsesrequest.mdx | 4 +- .../operations/createscimsyncjobresponse.mdx | 4 +- docs/models/operations/deletebatchrequest.mdx | 2 +- .../operations/deletebyokkeyrequest.mdx | 2 +- .../operations/deleteenduserrequest.mdx | 2 +- docs/models/operations/deletefilerequest.mdx | 6 +- .../operations/deleteguardrailrequest.mdx | 2 +- .../models/operations/deleteinternrequest.mdx | 4 +- .../deleteinternvaultsecretrequest.mdx | 4 +- docs/models/operations/deletekeysrequest.mdx | 2 +- docs/models/operations/deletekeysresponse.mdx | 2 +- .../deleteobservabilitydestinationrequest.mdx | 2 +- .../deleteprivateendpointrequest.mdx | 4 +- .../deletescimgroupmappingrequest.mdx | 4 +- .../operations/deletevaultsecretrequest.mdx | 2 +- .../deleteworkspacebudgetrequest.mdx | 4 +- .../operations/deleteworkspacerequest.mdx | 4 +- docs/models/operations/dimension.mdx | 4 +- .../disableprivateendpointrequest.mdx | 2 +- docs/models/operations/documentrequest.mdx | 4 +- docs/models/operations/documentresponse.mdx | 4 +- .../downloadcontainerfilecontentrequest.mdx | 4 +- .../operations/downloadfilecontentrequest.mdx | 6 +- .../enableprivateendpointrequest.mdx | 2 +- .../exchangeauthcodeforapikeyrequest.mdx | 6 +- .../exchangeauthcodeforapikeyresponse.mdx | 4 +- docs/models/operations/external.mdx | 4 +- docs/models/operations/filter.mdx | 8 +- .../operations/getanalyticsmetadata.mdx | 8 +- .../operations/getanalyticsmetaresponse.mdx | 2 +- .../operations/getapprankingsrequest.mdx | 14 +- .../operations/getapprankingsresponse.mdx | 2 +- docs/models/operations/getbatchesrequest.mdx | 2 +- .../operations/getbenchmarksrequest.mdx | 18 +- docs/models/operations/getbyokkeyrequest.mdx | 2 +- .../operations/getcontainerfilerequest.mdx | 4 +- docs/models/operations/getcreditsdata.mdx | 4 +- docs/models/operations/getcreditsresponse.mdx | 2 +- docs/models/operations/getcurrentkeydata.mdx | 46 +-- .../operations/getcurrentkeyresponse.mdx | 2 +- docs/models/operations/getenduserrequest.mdx | 2 +- .../operations/getfilemetadatarequest.mdx | 6 +- .../operations/getgenerationrequest.mdx | 2 +- .../models/operations/getguardrailrequest.mdx | 2 +- .../getinterndaemonaccessrequest.mdx | 2 +- .../operations/getinterndaemonrequest.mdx | 2 +- docs/models/operations/getinternrequest.mdx | 2 +- docs/models/operations/getkeydata.mdx | 46 +-- docs/models/operations/getkeyrequest.mdx | 2 +- docs/models/operations/getkeyresponse.mdx | 2 +- docs/models/operations/getmodelrequest.mdx | 4 +- docs/models/operations/getmodelsrequest.mdx | 58 ++-- docs/models/operations/getmodelsresponse.mdx | 2 +- .../getobservabilitydestinationrequest.mdx | 2 +- .../getorganizationsettingsresponse.mdx | 2 +- docs/models/operations/getpresetrequest.mdx | 2 +- .../operations/getpresetversionrequest.mdx | 4 +- .../operations/getprivateendpointrequest.mdx | 2 +- .../operations/getrankingsdailyrequest.mdx | 14 +- .../operations/getscimgroupmappingrequest.mdx | 2 +- .../operations/getscimsyncjobrequest.mdx | 2 +- .../operations/getsessioncostrequest.mdx | 10 +- .../operations/getsessioncostresponse.mdx | 2 +- .../gettaskclassificationsrequest.mdx | 2 +- docs/models/operations/gettoolrequest.mdx | 2 +- docs/models/operations/gettoolresponse.mdx | 4 +- docs/models/operations/gettoolsecurity.mdx | 2 +- .../operations/getuseractivityrequest.mdx | 10 +- docs/models/operations/getvideosrequest.mdx | 2 +- .../operations/getworkspacebudgetrequest.mdx | 4 +- .../models/operations/getworkspacerequest.mdx | 2 +- docs/models/operations/granularity.mdx | 4 +- docs/models/operations/imageurl.mdx | 2 +- docs/models/operations/input.mdx | 2 +- .../models/operations/invokeinternrequest.mdx | 4 +- .../operations/invokeinternresponse.mdx | 4 +- docs/models/operations/listbatchesrequest.mdx | 10 +- .../models/operations/listbatchesresponse.mdx | 2 +- .../models/operations/listbyokkeysrequest.mdx | 8 +- .../operations/listbyokkeysresponse.mdx | 2 +- .../operations/listcontainerfilesrequest.mdx | 6 +- docs/models/operations/listdata.mdx | 46 +-- .../listembeddingsmodelsrequest.mdx | 4 +- .../listembeddingsmodelsresponse.mdx | 2 +- .../operations/listendpointsrequest.mdx | 4 +- .../operations/listendpointsresponse.mdx | 2 +- .../operations/listendpointszdrresponse.mdx | 2 +- .../models/operations/listendusersrequest.mdx | 8 +- .../operations/listendusersresponse.mdx | 2 +- docs/models/operations/listfilesrequest.mdx | 16 +- docs/models/operations/listfilesresponse.mdx | 2 +- .../listgenerationcontentrequest.mdx | 2 +- .../listguardrailkeyassignmentsrequest.mdx | 6 +- .../listguardrailkeyassignmentsresponse.mdx | 2 +- .../listguardrailmemberassignmentsrequest.mdx | 6 +- ...listguardrailmemberassignmentsresponse.mdx | 2 +- .../operations/listguardrailsrequest.mdx | 6 +- .../operations/listguardrailsresponse.mdx | 2 +- .../listimagemodelendpointsrequest.mdx | 4 +- ...listinterneffectivevaultsecretsrequest.mdx | 6 +- docs/models/operations/listinternsrequest.mdx | 8 +- .../listinternvaultsecretsrequest.mdx | 6 +- .../operations/listkeyassignmentsrequest.mdx | 4 +- .../operations/listkeyassignmentsresponse.mdx | 2 +- .../listmemberassignmentsrequest.mdx | 4 +- .../listmemberassignmentsresponse.mdx | 2 +- .../operations/listmodelscountrequest.mdx | 2 +- .../operations/listmodelsuserrequest.mdx | 6 +- .../operations/listmodelsuserresponse.mdx | 2 +- .../operations/listmodelsusersecurity.mdx | 2 +- .../listobservabilitydestinationsrequest.mdx | 6 +- .../listobservabilitydestinationsresponse.mdx | 2 +- .../listorganizationmembersdata.mdx | 10 +- .../listorganizationmembersrequest.mdx | 4 +- .../listorganizationmembersresponse.mdx | 2 +- .../listorganizationmembersresponsebody.mdx | 4 +- docs/models/operations/listpresetsrequest.mdx | 4 +- .../models/operations/listpresetsresponse.mdx | 2 +- .../operations/listpresetversionsrequest.mdx | 6 +- .../operations/listpresetversionsresponse.mdx | 2 +- docs/models/operations/listprovidersdata.mdx | 14 +- .../operations/listprovidersresponse.mdx | 2 +- docs/models/operations/listrequest.mdx | 8 +- docs/models/operations/listresponse.mdx | 2 +- .../listscimgroupmappingsrequest.mdx | 4 +- .../listscimgroupmappingsresponse.mdx | 2 +- .../operations/listscimgroupsrequest.mdx | 8 +- .../operations/listscimgroupsresponse.mdx | 2 +- docs/models/operations/listtoolsrequest.mdx | 6 +- docs/models/operations/listtoolssecurity.mdx | 2 +- .../operations/listvaultsecretsrequest.mdx | 4 +- .../operations/listvideoscontentrequest.mdx | 4 +- .../listworkspacebudgetsrequest.mdx | 2 +- .../listworkspacemembersrequest.mdx | 6 +- .../listworkspacemembersresponse.mdx | 2 +- .../operations/listworkspacesrequest.mdx | 4 +- .../operations/listworkspacesresponse.mdx | 2 +- docs/models/operations/metadata.mdx | 6 +- docs/models/operations/metric.mdx | 8 +- docs/models/operations/operator.mdx | 4 +- docs/models/operations/orderby.mdx | 4 +- .../promotecontainerfilerequest.mdx | 4 +- .../models/operations/prompttokensdetails.mdx | 10 +- .../operations/provisioninternrequest.mdx | 2 +- .../models/operations/queryanalyticsdata2.mdx | 8 +- .../operations/queryanalyticsrequest.mdx | 20 +- .../operations/queryanalyticsresponse.mdx | 2 +- docs/models/operations/ratelimit.mdx | 8 +- docs/models/operations/result.mdx | 6 +- .../sendchatcompletionrequestrequest.mdx | 4 +- .../signinterndaemonaccessrequestrequest.mdx | 4 +- .../signinterndaemonaccessrequestresponse.mdx | 4 +- .../signinterndaemonrequestrequest.mdx | 4 +- .../signinterndaemonrequestresponse.mdx | 4 +- .../storeinternvaultsecretrequest.mdx | 6 +- .../operations/storevaultsecretrequest.mdx | 4 +- .../operations/suspendinternrequest.mdx | 2 +- docs/models/operations/timerange.mdx | 4 +- .../operations/updatebyokkeyrequest.mdx | 4 +- .../operations/updateenduserrequest.mdx | 4 +- .../operations/updateguardrailrequest.mdx | 4 +- .../models/operations/updateinternrequest.mdx | 4 +- docs/models/operations/updatekeysdata.mdx | 46 +-- docs/models/operations/updatekeysrequest.mdx | 4 +- .../operations/updatekeysrequestbody.mdx | 10 +- docs/models/operations/updatekeysresponse.mdx | 2 +- .../updateobservabilitydestinationrequest.mdx | 4 +- .../updateorganizationsettingsresponse.mdx | 2 +- .../updateprivateendpointpricingrequest.mdx | 4 +- .../updateprivateendpointrequest.mdx | 4 +- .../updatescimgroupmappingrequest.mdx | 4 +- .../operations/updateworkspacerequest.mdx | 4 +- docs/models/operations/uploadfilefile.mdx | 4 +- docs/models/operations/uploadfilerequest.mdx | 6 +- .../operations/uploadfilerequestbody.mdx | 2 +- .../upsertworkspacebudgetrequest.mdx | 6 +- .../validateprivateendpointrequest.mdx | 4 +- .../sdkerrors/badgatewayresponseerror.mdx | 6 +- .../sdkerrors/badrequestresponseerror.mdx | 6 +- docs/models/sdkerrors/batcherrorresponse.mdx | 2 +- .../batchpaymentrequiredresponseerror.mdx | 24 +- .../sdkerrors/conflictresponseerror.mdx | 6 +- ...eendpointvalidationfailedresponseerror.mdx | 4 +- .../edgenetworktimeoutresponseerror.mdx | 6 +- .../sdkerrors/forbiddenresponseerror.mdx | 6 +- .../sdkerrors/gatewaytimeoutresponseerror.mdx | 6 +- docs/models/sdkerrors/goneresponseerror.mdx | 6 +- .../sdkerrors/internalserverresponseerror.mdx | 6 +- .../sdkerrors/internchaterrorresponse.mdx | 2 +- .../models/sdkerrors/internlifecycleerror.mdx | 2 +- .../sdkerrors/notfoundresponseerror.mdx | 6 +- docs/models/sdkerrors/oautherrorresponse.mdx | 4 +- .../payloadtoolargeresponseerror.mdx | 6 +- .../paymentrequiredresponseerror.mdx | 6 +- .../provideroverloadedresponseerror.mdx | 6 +- .../sdkerrors/requesttimeoutresponseerror.mdx | 6 +- .../serviceunavailableresponseerror.mdx | 6 +- .../toomanyrequestsresponseerror.mdx | 6 +- .../sdkerrors/unauthorizedresponseerror.mdx | 6 +- .../unprocessableentityresponseerror.mdx | 6 +- docs/sdks/analytics/README.mdx | 24 +- docs/sdks/apikeys/README.mdx | 42 +-- docs/sdks/batch/README.mdx | 24 +- docs/sdks/benchmarks/README.mdx | 6 +- docs/sdks/betaresponses/README.mdx | 8 +- docs/sdks/byok/README.mdx | 38 +-- docs/sdks/chat/README.mdx | 8 +- docs/sdks/classifications/README.mdx | 6 +- docs/sdks/containers/README.mdx | 34 +- docs/sdks/credits/README.mdx | 4 +- docs/sdks/datasets/README.mdx | 18 +- docs/sdks/decisions/README.mdx | 6 +- docs/sdks/embeddings/README.mdx | 14 +- docs/sdks/endpoints/README.mdx | 12 +- docs/sdks/endusers/README.mdx | 38 +-- docs/sdks/files/README.mdx | 46 +-- docs/sdks/generations/README.mdx | 18 +- docs/sdks/guardrails/README.mdx | 104 +++---- docs/sdks/images/README.mdx | 18 +- docs/sdks/interns/README.mdx | 106 +++---- docs/sdks/models/README.mdx | 32 +- docs/sdks/oauth/README.mdx | 22 +- docs/sdks/observability/README.mdx | 36 +-- docs/sdks/organization/README.mdx | 18 +- docs/sdks/presets/README.mdx | 56 ++-- docs/sdks/privateendpoints/README.mdx | 68 ++-- docs/sdks/providers/README.mdx | 4 +- docs/sdks/rerank/README.mdx | 6 +- docs/sdks/responses/README.mdx | 8 +- docs/sdks/scim/README.mdx | 58 ++-- docs/sdks/stt/README.mdx | 12 +- docs/sdks/systemone/README.mdx | 6 +- docs/sdks/tools/README.mdx | 20 +- docs/sdks/tts/README.mdx | 6 +- docs/sdks/vault/README.mdx | 68 ++-- docs/sdks/videogeneration/README.mdx | 24 +- docs/sdks/workspaces/README.mdx | 94 +++--- 1258 files changed, 6031 insertions(+), 6031 deletions(-) diff --git a/docs/models/components/aabenchmarkentry.mdx b/docs/models/components/aabenchmarkentry.mdx index e22b143cf..db2276972 100644 --- a/docs/models/components/aabenchmarkentry.mdx +++ b/docs/models/components/aabenchmarkentry.mdx @@ -9,6 +9,6 @@ Artificial Analysis benchmark index scores. | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `AgenticIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 | -| `CodingIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 | -| `IntelligenceIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file +| `AgenticIndex` | `*float64` | ✅ | Artificial Analysis Agentic Index score | 55.8 | +| `CodingIndex` | `*float64` | ✅ | Artificial Analysis Coding Index score | 63.2 | +| `IntelligenceIndex` | `*float64` | ✅ | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file diff --git a/docs/models/components/activityitem.mdx b/docs/models/components/activityitem.mdx index 2207b59ba..a661a114a 100644 --- a/docs/models/components/activityitem.mdx +++ b/docs/models/components/activityitem.mdx @@ -6,16 +6,16 @@ title: "ActivityItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsageInference` | `float64` | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | -| `CachedTokens` | `int64` | :heavy_check_mark: | Total prompt tokens read from the provider prompt cache (cache hits). Generally a subset of `prompt_tokens`; for replayed response-cache hits the provider may report the two counters over disjoint token sets, so `cached_tokens` can exceed `prompt_tokens`. | 10 | -| `CompletionTokens` | `int64` | :heavy_check_mark: | Total completion tokens generated | 125 | -| `Date` | `string` | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `EndpointID` | `string` | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `Model` | `string` | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `PromptTokens` | `int64` | :heavy_check_mark: | Total prompt tokens used | 50 | -| `ProviderName` | `string` | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | -| `ReasoningTokens` | `int64` | :heavy_check_mark: | Total reasoning tokens used | 25 | -| `Requests` | `int64` | :heavy_check_mark: | Number of requests made | 5 | -| `Usage` | `float64` | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | ID of the workspace this activity is attributed to. Only present when `group_by=workspace` is passed; the response is then split per workspace. Activity recorded before workspace resolution existed is attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `BYOKUsageInference` | `float64` | ✅ | BYOK inference cost in USD (external credits spent) | 0.012 | +| `CachedTokens` | `int64` | ✅ | Total prompt tokens read from the provider prompt cache (cache hits). Generally a subset of `prompt_tokens`; for replayed response-cache hits the provider may report the two counters over disjoint token sets, so `cached_tokens` can exceed `prompt_tokens`. | 10 | +| `CompletionTokens` | `int64` | ✅ | Total completion tokens generated | 125 | +| `Date` | `string` | ✅ | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | +| `EndpointID` | `string` | ✅ | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | +| `Model` | `string` | ✅ | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | +| `ModelPermaslug` | `string` | ✅ | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | +| `PromptTokens` | `int64` | ✅ | Total prompt tokens used | 50 | +| `ProviderName` | `string` | ✅ | Name of the provider serving this endpoint | OpenAI | +| `ReasoningTokens` | `int64` | ✅ | Total reasoning tokens used | 25 | +| `Requests` | `int64` | ✅ | Number of requests made | 5 | +| `Usage` | `float64` | ✅ | Total cost in USD (OpenRouter credits spent) | 0.015 | +| `WorkspaceID` | `*string` | ➖ | ID of the workspace this activity is attributed to. Only present when `group_by=workspace` is passed; the response is then split per workspace. Activity recorded before workspace resolution existed is attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/activityresponse.mdx b/docs/models/components/activityresponse.mdx index 4fd6bd116..541d5f7d7 100644 --- a/docs/models/components/activityresponse.mdx +++ b/docs/models/components/activityresponse.mdx @@ -6,4 +6,4 @@ title: "ActivityResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Data` | [][components.ActivityItem](../../models/components/activityitem.mdx) | :heavy_check_mark: | List of activity items | \ No newline at end of file +| `Data` | [][components.ActivityItem](../../models/components/activityitem.mdx) | ✅ | List of activity items | \ No newline at end of file diff --git a/docs/models/components/additionaltoolsitem.mdx b/docs/models/components/additionaltoolsitem.mdx index 3c00f4bd5..3ff9dffec 100644 --- a/docs/models/components/additionaltoolsitem.mdx +++ b/docs/models/components/additionaltoolsitem.mdx @@ -9,7 +9,7 @@ Additional tools made available to the model at this point in the input | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Role` | [components.AdditionalToolsItemRole](../../models/components/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A | -| `Tools` | [][components.AdditionalToolsItemToolUnion](../../models/components/additionaltoolsitemtoolunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.TypeAdditionalTools](../../models/components/typeadditionaltools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Role` | [components.AdditionalToolsItemRole](../../models/components/additionaltoolsitemrole.mdx) | ✅ | N/A | +| `Tools` | [][components.AdditionalToolsItemToolUnion](../../models/components/additionaltoolsitemtoolunion.mdx) | ✅ | N/A | +| `Type` | [components.TypeAdditionalTools](../../models/components/typeadditionaltools.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/additionaltoolsitemtool.mdx b/docs/models/components/additionaltoolsitemtool.mdx index aac7add44..dee019313 100644 --- a/docs/models/components/additionaltoolsitemtool.mdx +++ b/docs/models/components/additionaltoolsitemtool.mdx @@ -6,5 +6,5 @@ title: "AdditionalToolsItemTool" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | `string` | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/additionaltoolsitemtoolfunction.mdx b/docs/models/components/additionaltoolsitemtoolfunction.mdx index 74e3f14e6..3cd4e1b74 100644 --- a/docs/models/components/additionaltoolsitemtoolfunction.mdx +++ b/docs/models/components/additionaltoolsitemtoolfunction.mdx @@ -9,10 +9,10 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.AdditionalToolsItemTypeFunction](../../models/components/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A | | -| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Parameters` | map[string]`any` | ✅ | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `Type` | [components.AdditionalToolsItemTypeFunction](../../models/components/additionaltoolsitemtypefunction.mdx) | ✅ | N/A | | +| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/components/advisorreasoning.mdx b/docs/models/components/advisorreasoning.mdx index e1eb8f5f7..f6c42539f 100644 --- a/docs/models/components/advisorreasoning.mdx +++ b/docs/models/components/advisorreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the advisor call. Use this to control reaso | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `Effort` | [*components.AdvisorReasoningEffort](../../models/components/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | -| `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file +| `Effort` | [*components.AdvisorReasoningEffort](../../models/components/advisorreasoningeffort.mdx) | ➖ | Reasoning effort level for the advisor call. | +| `MaxTokens` | `*int64` | ➖ | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file diff --git a/docs/models/components/advisorservertoolconfig.mdx b/docs/models/components/advisorservertoolconfig.mdx index 6a2c62132..c1168ce9e 100644 --- a/docs/models/components/advisorservertoolconfig.mdx +++ b/docs/models/components/advisorservertoolconfig.mdx @@ -9,11 +9,11 @@ Configuration for one openrouter:advisor server tool entry. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ForwardTranscript` | `*bool` | :heavy_minus_sign: | When true, the full parent conversation is forwarded to the advisor so it sees the same context the executor does (and the tool-call `prompt`, if given, is appended as a final user turn). When false or omitted, the advisor receives only the `prompt` the executor passes in the tool call. | false | -| `Instructions` | `*string` | :heavy_minus_sign: | System instructions for the advisor sub-agent. When omitted, the advisor responds with no system prompt of its own. | You are a senior staff engineer. Give a focused, decisive plan. | -| `MaxCompletionTokens` | `*int64` | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | -| `Model` | `*string` | :heavy_minus_sign: | Slug of the advisor model to consult (any OpenRouter model). When omitted, the executor can choose it via the tool call's `model` argument; if neither is set, the model from the outer API request is used. | ~anthropic/claude-opus-latest | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for this advisor. The model sees one tool per named advisor (and one default for an unnamed entry). Names must be unique across advisor entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | reviewer | -| `Reasoning` | [*components.AdvisorReasoning](../../models/components/advisorreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to the advisor call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "high"
} | -| `Stream` | `*bool` | :heavy_minus_sign: | When true, the advisor's advice streams incrementally as it is produced. In the Responses API this emits `response.output_text.delta` events targeting the advisor output item; the final `advice` field is still set on the completed item. Has no effect on the Chat Completions API (where the advice arrives only as the final tool result). When false or omitted, the advice arrives only as the final result. | false | -| `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file +| `ForwardTranscript` | `*bool` | ➖ | When true, the full parent conversation is forwarded to the advisor so it sees the same context the executor does (and the tool-call `prompt`, if given, is appended as a final user turn). When false or omitted, the advisor receives only the `prompt` the executor passes in the tool call. | false | +| `Instructions` | `*string` | ➖ | System instructions for the advisor sub-agent. When omitted, the advisor responds with no system prompt of its own. | You are a senior staff engineer. Give a focused, decisive plan. | +| `MaxCompletionTokens` | `*int64` | ➖ | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | +| `Model` | `*string` | ➖ | Slug of the advisor model to consult (any OpenRouter model). When omitted, the executor can choose it via the tool call's `model` argument; if neither is set, the model from the outer API request is used. | ~anthropic/claude-opus-latest | +| `Name` | `*string` | ➖ | Optional name for this advisor. The model sees one tool per named advisor (and one default for an unnamed entry). Names must be unique across advisor entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | reviewer | +| `Reasoning` | [*components.AdvisorReasoning](../../models/components/advisorreasoning.mdx) | ➖ | Reasoning configuration forwarded to the advisor call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "high"
} | +| `Stream` | `*bool` | ➖ | When true, the advisor's advice streams incrementally as it is produced. In the Responses API this emits `response.output_text.delta` events targeting the advisor output item; the final `advice` field is still set on the completed item. Has no effect on the Chat Completions API (where the advice arrives only as the final tool result). When false or omitted, the advice arrives only as the final result. | false | +| `Temperature` | `*float64` | ➖ | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file diff --git a/docs/models/components/advisorservertoolopenrouter.mdx b/docs/models/components/advisorservertoolopenrouter.mdx index 7d498b118..6ca538efa 100644 --- a/docs/models/components/advisorservertoolopenrouter.mdx +++ b/docs/models/components/advisorservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: consults a higher-intelligence advisor model (a | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.AdvisorServerToolConfig](../../models/components/advisorservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | -| `Type` | [components.AdvisorServerToolOpenRouterType](../../models/components/advisorservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.AdvisorServerToolConfig](../../models/components/advisorservertoolconfig.mdx) | ➖ | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | +| `Type` | [components.AdvisorServerToolOpenRouterType](../../models/components/advisorservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/agent.mdx b/docs/models/components/agent.mdx index 6b4b43330..f449b49ca 100644 --- a/docs/models/components/agent.mdx +++ b/docs/models/components/agent.mdx @@ -6,5 +6,5 @@ title: "Agent" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `AgentName` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `AgentName` | `string` | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/agentmessageitem.mdx b/docs/models/components/agentmessageitem.mdx index a11f51898..1bb5cfa4b 100644 --- a/docs/models/components/agentmessageitem.mdx +++ b/docs/models/components/agentmessageitem.mdx @@ -9,10 +9,10 @@ A message routed between agents in a multi-agent session | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `Agent` | optionalnullable.OptionalNullable[[components.Agent](../../models/components/agent.mdx)] | :heavy_minus_sign: | N/A | | -| `Author` | `string` | :heavy_check_mark: | N/A | | -| `Content` | [][components.AgentMessageItemContentUnion](../../models/components/agentmessageitemcontentunion.mdx) | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Recipient` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeAgentMessage](../../models/components/typeagentmessage.mdx) | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"author": "/root/worker",
"content": [
\{
"text": "Task complete.",
"type": "input_text"
}
],
"recipient": "/root",
"type": "agent_message"
} | \ No newline at end of file +| `Agent` | optionalnullable.OptionalNullable[[components.Agent](../../models/components/agent.mdx)] | ➖ | N/A | | +| `Author` | `string` | ✅ | N/A | | +| `Content` | [][components.AgentMessageItemContentUnion](../../models/components/agentmessageitemcontentunion.mdx) | ✅ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Recipient` | `string` | ✅ | N/A | | +| `Type` | [components.TypeAgentMessage](../../models/components/typeagentmessage.mdx) | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"author": "/root/worker",
"content": [
\{
"text": "Task complete.",
"type": "input_text"
}
],
"recipient": "/root",
"type": "agent_message"
} | \ No newline at end of file diff --git a/docs/models/components/agentmessageitemcontentinputimage.mdx b/docs/models/components/agentmessageitemcontentinputimage.mdx index d42349fe7..34d75d235 100644 --- a/docs/models/components/agentmessageitemcontentinputimage.mdx +++ b/docs/models/components/agentmessageitemcontentinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.AgentMessageItemDetail](../../models/components/agentmessageitemdetail.mdx) | :heavy_check_mark: | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.AgentMessageItemTypeInputImage](../../models/components/agentmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Detail` | [components.AgentMessageItemDetail](../../models/components/agentmessageitemdetail.mdx) | ✅ | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.AgentMessageItemTypeInputImage](../../models/components/agentmessageitemtypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/alignment.mdx b/docs/models/components/alignment.mdx index 3dd1f5b58..e05c5d9c5 100644 --- a/docs/models/components/alignment.mdx +++ b/docs/models/components/alignment.mdx @@ -9,4 +9,4 @@ Beta. The result of the alignment plugin for this request; the shape may change. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Calls` | [][components.AlignmentCallRecord](../../models/components/alignmentcallrecord.mdx) | :heavy_check_mark: | One record per evaluated assistant message of the request, in the order the messages were produced. | \ No newline at end of file +| `Calls` | [][components.AlignmentCallRecord](../../models/components/alignmentcallrecord.mdx) | ✅ | One record per evaluated assistant message of the request, in the order the messages were produced. | \ No newline at end of file diff --git a/docs/models/components/alignmentallowedcallrecord.mdx b/docs/models/components/alignmentallowedcallrecord.mdx index c53c0c1fc..85b7b6977 100644 --- a/docs/models/components/alignmentallowedcallrecord.mdx +++ b/docs/models/components/alignmentallowedcallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentAllowedCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Call` | `int64` | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `Outcome` | [components.AlignmentAllowedCallRecordOutcome](../../models/components/alignmentallowedcallrecordoutcome.mdx) | :heavy_check_mark: | N/A | -| `Rules` | [][components.AlignmentRuleRecord](../../models/components/alignmentrulerecord.mdx) | :heavy_check_mark: | One record per rule, in the order of `rules` in the request. | \ No newline at end of file +| `Call` | `int64` | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `Outcome` | [components.AlignmentAllowedCallRecordOutcome](../../models/components/alignmentallowedcallrecordoutcome.mdx) | ✅ | N/A | +| `Rules` | [][components.AlignmentRuleRecord](../../models/components/alignmentrulerecord.mdx) | ✅ | One record per rule, in the order of `rules` in the request. | \ No newline at end of file diff --git a/docs/models/components/alignmentblockedcallrecord.mdx b/docs/models/components/alignmentblockedcallrecord.mdx index 699c22f59..c03d0c1d4 100644 --- a/docs/models/components/alignmentblockedcallrecord.mdx +++ b/docs/models/components/alignmentblockedcallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentBlockedCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Call` | `int64` | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `Outcome` | [components.AlignmentBlockedCallRecordOutcome](../../models/components/alignmentblockedcallrecordoutcome.mdx) | :heavy_check_mark: | N/A | -| `Rules` | [][components.AlignmentRuleRecord](../../models/components/alignmentrulerecord.mdx) | :heavy_check_mark: | One record per rule, in the order of `rules` in the request. | \ No newline at end of file +| `Call` | `int64` | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `Outcome` | [components.AlignmentBlockedCallRecordOutcome](../../models/components/alignmentblockedcallrecordoutcome.mdx) | ✅ | N/A | +| `Rules` | [][components.AlignmentRuleRecord](../../models/components/alignmentrulerecord.mdx) | ✅ | One record per rule, in the order of `rules` in the request. | \ No newline at end of file diff --git a/docs/models/components/alignmentchataudio.mdx b/docs/models/components/alignmentchataudio.mdx index 610df35df..9d4d73d3e 100644 --- a/docs/models/components/alignmentchataudio.mdx +++ b/docs/models/components/alignmentchataudio.mdx @@ -9,5 +9,5 @@ The audio of the withheld message: its `id` and `transcript`. The plugin does no | Field | Type | Required | Description | | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `ID` | `*string` | :heavy_minus_sign: | The provider id of the audio. | -| `Transcript` | `string` | :heavy_check_mark: | The transcript of the audio. | \ No newline at end of file +| `ID` | `*string` | ➖ | The provider id of the audio. | +| `Transcript` | `string` | ✅ | The transcript of the audio. | \ No newline at end of file diff --git a/docs/models/components/alignmentchatimage.mdx b/docs/models/components/alignmentchatimage.mdx index 7db4664c9..61192c4a7 100644 --- a/docs/models/components/alignmentchatimage.mdx +++ b/docs/models/components/alignmentchatimage.mdx @@ -6,5 +6,5 @@ title: "AlignmentChatImage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ImageURL` | [components.AlignmentChatImageImageURL](../../models/components/alignmentchatimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AlignmentChatImageType](../../models/components/alignmentchatimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.AlignmentChatImageImageURL](../../models/components/alignmentchatimageimageurl.mdx) | ✅ | N/A | +| `Type` | [components.AlignmentChatImageType](../../models/components/alignmentchatimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/alignmentchatimageimageurl.mdx b/docs/models/components/alignmentchatimageimageurl.mdx index fb39cc71c..f3458b63d 100644 --- a/docs/models/components/alignmentchatimageimageurl.mdx +++ b/docs/models/components/alignmentchatimageimageurl.mdx @@ -6,4 +6,4 @@ title: "AlignmentChatImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/alignmentchatrejected.mdx b/docs/models/components/alignmentchatrejected.mdx index 515f2d0a5..ed8ad7b2a 100644 --- a/docs/models/components/alignmentchatrejected.mdx +++ b/docs/models/components/alignmentchatrejected.mdx @@ -9,9 +9,9 @@ The assistant message of the withheld turn, without reasoning. `audio` holds the | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Audio` | [*components.AlignmentChatAudio](../../models/components/alignmentchataudio.mdx) | :heavy_minus_sign: | The audio of the withheld message: its `id` and `transcript`. The plugin does not retain `data` or `expires_at`. | \{
"id": "audio_abc123",
"transcript": "Sure, I can take 20% off your order."
} | -| `Content` | `*string` | :heavy_check_mark: | N/A | | -| `Images` | [][components.AlignmentChatImage](../../models/components/alignmentchatimage.mdx) | :heavy_minus_sign: | N/A | | -| `Refusal` | `*string` | :heavy_check_mark: | N/A | | -| `Role` | [components.AlignmentChatRejectedRole](../../models/components/alignmentchatrejectedrole.mdx) | :heavy_check_mark: | N/A | | -| `ToolCalls` | [][components.AlignmentChatToolCall](../../models/components/alignmentchattoolcall.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Audio` | [*components.AlignmentChatAudio](../../models/components/alignmentchataudio.mdx) | ➖ | The audio of the withheld message: its `id` and `transcript`. The plugin does not retain `data` or `expires_at`. | \{
"id": "audio_abc123",
"transcript": "Sure, I can take 20% off your order."
} | +| `Content` | `*string` | ✅ | N/A | | +| `Images` | [][components.AlignmentChatImage](../../models/components/alignmentchatimage.mdx) | ➖ | N/A | | +| `Refusal` | `*string` | ✅ | N/A | | +| `Role` | [components.AlignmentChatRejectedRole](../../models/components/alignmentchatrejectedrole.mdx) | ✅ | N/A | | +| `ToolCalls` | [][components.AlignmentChatToolCall](../../models/components/alignmentchattoolcall.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/alignmentchattoolcall.mdx b/docs/models/components/alignmentchattoolcall.mdx index 878956fe6..347bb0223 100644 --- a/docs/models/components/alignmentchattoolcall.mdx +++ b/docs/models/components/alignmentchattoolcall.mdx @@ -6,6 +6,6 @@ title: "AlignmentChatToolCall" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Function` | [components.AlignmentChatToolCallFunction](../../models/components/alignmentchattoolcallfunction.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AlignmentChatToolCallType](../../models/components/alignmentchattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Function` | [components.AlignmentChatToolCallFunction](../../models/components/alignmentchattoolcallfunction.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Type` | [components.AlignmentChatToolCallType](../../models/components/alignmentchattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/alignmentchattoolcallfunction.mdx b/docs/models/components/alignmentchattoolcallfunction.mdx index 937003467..5d128bbf9 100644 --- a/docs/models/components/alignmentchattoolcallfunction.mdx +++ b/docs/models/components/alignmentchattoolcallfunction.mdx @@ -6,5 +6,5 @@ title: "AlignmentChatToolCallFunction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/alignmentplugin.mdx b/docs/models/components/alignmentplugin.mdx index 27910344e..965076e56 100644 --- a/docs/models/components/alignmentplugin.mdx +++ b/docs/models/components/alignmentplugin.mdx @@ -9,9 +9,9 @@ Beta. States the listed rules to the model and evaluates every turn against them | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | [components.AlignmentPluginID](../../models/components/alignmentpluginid.mdx) | :heavy_check_mark: | N/A | | -| `Instruct` | `*bool` | :heavy_minus_sign: | Whether the rules are stated to the model in a system message on every provider call. Default true. | | -| `MaxRetries` | `*int64` | :heavy_minus_sign: | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | -| `Mode` | [*components.AlignmentPluginMode](../../models/components/alignmentpluginmode.mdx) | :heavy_minus_sign: | `enforce`: a turn that breaks a rule is withheld, retried, and finally returned as an error. `audit`: every turn is evaluated and returned. Default `enforce`. | | -| `Rules` | []`string` | :heavy_check_mark: | Texts that state what the reply must do or must not do. Each rule is evaluated on its own. | [
"Never offer a discount.",
"End with exactly one question."
] | -| `Threshold` | `*float64` | :heavy_minus_sign: | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file +| `ID` | [components.AlignmentPluginID](../../models/components/alignmentpluginid.mdx) | ✅ | N/A | | +| `Instruct` | `*bool` | ➖ | Whether the rules are stated to the model in a system message on every provider call. Default true. | | +| `MaxRetries` | `*int64` | ➖ | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | +| `Mode` | [*components.AlignmentPluginMode](../../models/components/alignmentpluginmode.mdx) | ➖ | `enforce`: a turn that breaks a rule is withheld, retried, and finally returned as an error. `audit`: every turn is evaluated and returned. Default `enforce`. | | +| `Rules` | []`string` | ✅ | Texts that state what the reply must do or must not do. Each rule is evaluated on its own. | [
"Never offer a discount.",
"End with exactly one question."
] | +| `Threshold` | `*float64` | ➖ | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file diff --git a/docs/models/components/alignmentrulerecord.mdx b/docs/models/components/alignmentrulerecord.mdx index 9c2288506..32a0e7e17 100644 --- a/docs/models/components/alignmentrulerecord.mdx +++ b/docs/models/components/alignmentrulerecord.mdx @@ -6,5 +6,5 @@ title: "AlignmentRuleRecord" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Broken` | `bool` | :heavy_check_mark: | Whether probability is at or above the threshold. | -| `Probability` | `float64` | :heavy_check_mark: | The evaluator's probability that the turn breaks the rule. | \ No newline at end of file +| `Broken` | `bool` | ✅ | Whether probability is at or above the threshold. | +| `Probability` | `float64` | ✅ | The evaluator's probability that the turn breaks the rule. | \ No newline at end of file diff --git a/docs/models/components/alignmentunavailablecallrecord.mdx b/docs/models/components/alignmentunavailablecallrecord.mdx index 53c05b2d0..8fe4b317f 100644 --- a/docs/models/components/alignmentunavailablecallrecord.mdx +++ b/docs/models/components/alignmentunavailablecallrecord.mdx @@ -6,6 +6,6 @@ title: "AlignmentUnavailableCallRecord" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Call` | `int64` | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `Outcome` | [components.AlignmentUnavailableCallRecordOutcome](../../models/components/alignmentunavailablecallrecordoutcome.mdx) | :heavy_check_mark: | N/A | -| `Reason` | [components.AlignmentUnavailableCallRecordReason](../../models/components/alignmentunavailablecallrecordreason.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Call` | `int64` | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `Outcome` | [components.AlignmentUnavailableCallRecordOutcome](../../models/components/alignmentunavailablecallrecordoutcome.mdx) | ✅ | N/A | +| `Reason` | [components.AlignmentUnavailableCallRecordReason](../../models/components/alignmentunavailablecallrecordreason.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/allowedtools.mdx b/docs/models/components/allowedtools.mdx index cee77733f..3c7405e89 100644 --- a/docs/models/components/allowedtools.mdx +++ b/docs/models/components/allowedtools.mdx @@ -6,5 +6,5 @@ title: "AllowedTools" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ReadOnly` | `*bool` | :heavy_minus_sign: | N/A | -| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ReadOnly` | `*bool` | ➖ | N/A | +| `ToolNames` | []`string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/always.mdx b/docs/models/components/always.mdx index a10039076..6b42f544b 100644 --- a/docs/models/components/always.mdx +++ b/docs/models/components/always.mdx @@ -6,4 +6,4 @@ title: "Always" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ToolNames` | []`string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/annotationaddedevent.mdx b/docs/models/components/annotationaddedevent.mdx index d7a722dc5..38d5fa678 100644 --- a/docs/models/components/annotationaddedevent.mdx +++ b/docs/models/components/annotationaddedevent.mdx @@ -9,10 +9,10 @@ Event emitted when a text annotation is added to output | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Annotation` | [components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | :heavy_check_mark: | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | -| `AnnotationIndex` | `int64` | :heavy_check_mark: | N/A | | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | | -| `ItemID` | `string` | :heavy_check_mark: | N/A | | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnnotationAddedEventType](../../models/components/annotationaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Annotation` | [components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | ✅ | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | +| `AnnotationIndex` | `int64` | ✅ | N/A | | +| `ContentIndex` | `int64` | ✅ | N/A | | +| `ItemID` | `string` | ✅ | N/A | | +| `OutputIndex` | `int64` | ✅ | N/A | | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.AnnotationAddedEventType](../../models/components/annotationaddedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/annotationfile.mdx b/docs/models/components/annotationfile.mdx index bfd4ada5d..23f8622dd 100644 --- a/docs/models/components/annotationfile.mdx +++ b/docs/models/components/annotationfile.mdx @@ -6,5 +6,5 @@ title: "AnnotationFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `File` | [components.BatchObjectFile](../../models/components/batchobjectfile.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnnotationTypeFile](../../models/components/annotationtypefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `File` | [components.BatchObjectFile](../../models/components/batchobjectfile.mdx) | ✅ | N/A | +| `Type` | [components.AnnotationTypeFile](../../models/components/annotationtypefile.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/annotationurlcitation.mdx b/docs/models/components/annotationurlcitation.mdx index 5cc8d6770..8d77c0f4e 100644 --- a/docs/models/components/annotationurlcitation.mdx +++ b/docs/models/components/annotationurlcitation.mdx @@ -6,5 +6,5 @@ title: "AnnotationURLCitation" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnnotationTypeURLCitation](../../models/components/annotationtypeurlcitation.mdx) | :heavy_check_mark: | N/A | -| `URLCitation` | [components.BatchObjectURLCitation](../../models/components/batchobjecturlcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnnotationTypeURLCitation](../../models/components/annotationtypeurlcitation.mdx) | ✅ | N/A | +| `URLCitation` | [components.BatchObjectURLCitation](../../models/components/batchobjecturlcitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/annotationwebsearchcitation.mdx b/docs/models/components/annotationwebsearchcitation.mdx index ca239e366..3f3d9cbbe 100644 --- a/docs/models/components/annotationwebsearchcitation.mdx +++ b/docs/models/components/annotationwebsearchcitation.mdx @@ -6,5 +6,5 @@ title: "AnnotationWebSearchCitation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.TypeWebSearchCitation](../../models/components/typewebsearchcitation.mdx) | :heavy_check_mark: | N/A | -| `WebSearchCitation` | [components.WebSearchCitation](../../models/components/websearchcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeWebSearchCitation](../../models/components/typewebsearchcitation.mdx) | ✅ | N/A | +| `WebSearchCitation` | [components.WebSearchCitation](../../models/components/websearchcitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicadvisormessageusageiteration.mdx b/docs/models/components/anthropicadvisormessageusageiteration.mdx index ee2480e10..496027c36 100644 --- a/docs/models/components/anthropicadvisormessageusageiteration.mdx +++ b/docs/models/components/anthropicadvisormessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicAdvisorMessageUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicAdvisorMessageUsageIterationType](../../models/components/anthropicadvisormessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreationInputTokens` | `*int64` | ➖ | N/A | | +| `CacheReadInputTokens` | `*int64` | ➖ | N/A | | +| `InputTokens` | `*int64` | ➖ | N/A | | +| `OutputTokens` | `*int64` | ➖ | N/A | | +| `Model` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicAdvisorMessageUsageIterationType](../../models/components/anthropicadvisormessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicadvisortoolresult.mdx b/docs/models/components/anthropicadvisortoolresult.mdx index 24988a6f8..3c408c4f4 100644 --- a/docs/models/components/anthropicadvisortoolresult.mdx +++ b/docs/models/components/anthropicadvisortoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicAdvisorToolResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Content` | map[string]`any` | :heavy_check_mark: | N/A | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicAdvisorToolResultType](../../models/components/anthropicadvisortoolresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | map[string]`any` | ✅ | N/A | +| `ToolUseID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicAdvisorToolResultType](../../models/components/anthropicadvisortoolresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicbase64imagesource.mdx b/docs/models/components/anthropicbase64imagesource.mdx index b97e64b9a..d7d52212a 100644 --- a/docs/models/components/anthropicbase64imagesource.mdx +++ b/docs/models/components/anthropicbase64imagesource.mdx @@ -6,6 +6,6 @@ title: "AnthropicBase64ImageSource" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | :heavy_check_mark: | N/A | | -| `MediaType` | [components.AnthropicImageMimeType](../../models/components/anthropicimagemimetype.mdx) | :heavy_check_mark: | N/A | image/jpeg | -| `Type` | [components.AnthropicBase64ImageSourceType](../../models/components/anthropicbase64imagesourcetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Data` | `string` | ✅ | N/A | | +| `MediaType` | [components.AnthropicImageMimeType](../../models/components/anthropicimagemimetype.mdx) | ✅ | N/A | image/jpeg | +| `Type` | [components.AnthropicBase64ImageSourceType](../../models/components/anthropicbase64imagesourcetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicbase64pdfsource.mdx b/docs/models/components/anthropicbase64pdfsource.mdx index 85776a1e9..fefa9d30c 100644 --- a/docs/models/components/anthropicbase64pdfsource.mdx +++ b/docs/models/components/anthropicbase64pdfsource.mdx @@ -6,6 +6,6 @@ title: "AnthropicBase64PdfSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `MediaType` | [components.AnthropicBase64PdfSourceMediaType](../../models/components/anthropicbase64pdfsourcemediatype.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicBase64PdfSourceType](../../models/components/anthropicbase64pdfsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | `string` | ✅ | N/A | +| `MediaType` | [components.AnthropicBase64PdfSourceMediaType](../../models/components/anthropicbase64pdfsourcemediatype.mdx) | ✅ | N/A | +| `Type` | [components.AnthropicBase64PdfSourceType](../../models/components/anthropicbase64pdfsourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicbashcodeexecutionoutput.mdx b/docs/models/components/anthropicbashcodeexecutionoutput.mdx index defdf13c3..87c751afa 100644 --- a/docs/models/components/anthropicbashcodeexecutionoutput.mdx +++ b/docs/models/components/anthropicbashcodeexecutionoutput.mdx @@ -6,5 +6,5 @@ title: "AnthropicBashCodeExecutionOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicBashCodeExecutionOutputType](../../models/components/anthropicbashcodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicBashCodeExecutionOutputType](../../models/components/anthropicbashcodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicbashcodeexecutionresult.mdx b/docs/models/components/anthropicbashcodeexecutionresult.mdx index e797c53ee..a0177b3e9 100644 --- a/docs/models/components/anthropicbashcodeexecutionresult.mdx +++ b/docs/models/components/anthropicbashcodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicBashCodeExecutionResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Content` | [][components.AnthropicBashCodeExecutionOutput](../../models/components/anthropicbashcodeexecutionoutput.mdx) | :heavy_check_mark: | N/A | -| `ReturnCode` | `int64` | :heavy_check_mark: | N/A | -| `Stderr` | `string` | :heavy_check_mark: | N/A | -| `Stdout` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicBashCodeExecutionResultType](../../models/components/anthropicbashcodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [][components.AnthropicBashCodeExecutionOutput](../../models/components/anthropicbashcodeexecutionoutput.mdx) | ✅ | N/A | +| `ReturnCode` | `int64` | ✅ | N/A | +| `Stderr` | `string` | ✅ | N/A | +| `Stdout` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicBashCodeExecutionResultType](../../models/components/anthropicbashcodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicbashcodeexecutiontoolresult.mdx b/docs/models/components/anthropicbashcodeexecutiontoolresult.mdx index 87ccab406..850040fe0 100644 --- a/docs/models/components/anthropicbashcodeexecutiontoolresult.mdx +++ b/docs/models/components/anthropicbashcodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicBashCodeExecutionToolResult" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicBashCodeExecutionContent](../../models/components/anthropicbashcodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicBashCodeExecutionToolResultType](../../models/components/anthropicbashcodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicBashCodeExecutionContent](../../models/components/anthropicbashcodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | +| `ToolUseID` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicBashCodeExecutionToolResultType](../../models/components/anthropicbashcodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicbashcodeexecutiontoolresulterror.mdx b/docs/models/components/anthropicbashcodeexecutiontoolresulterror.mdx index 32a63b39d..a14f2efa7 100644 --- a/docs/models/components/anthropicbashcodeexecutiontoolresulterror.mdx +++ b/docs/models/components/anthropicbashcodeexecutiontoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicBashCodeExecutionToolResultError" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicBashCodeExecutionToolResultErrorErrorCode](../../models/components/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicBashCodeExecutionToolResultErrorType](../../models/components/anthropicbashcodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ErrorCode` | [components.AnthropicBashCodeExecutionToolResultErrorErrorCode](../../models/components/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `Type` | [components.AnthropicBashCodeExecutionToolResultErrorType](../../models/components/anthropicbashcodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccachecontroldirective.mdx b/docs/models/components/anthropiccachecontroldirective.mdx index ef3026af8..33f489d21 100644 --- a/docs/models/components/anthropiccachecontroldirective.mdx +++ b/docs/models/components/anthropiccachecontroldirective.mdx @@ -9,5 +9,5 @@ Enable automatic prompt caching. When set at the top level, the system automatic | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `Type` | [components.AnthropicCacheControlDirectiveType](../../models/components/anthropiccachecontroldirectivetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | +| `Type` | [components.AnthropicCacheControlDirectiveType](../../models/components/anthropiccachecontroldirectivetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccachecreation.mdx b/docs/models/components/anthropiccachecreation.mdx index e8d95fc3a..7e84b6259 100644 --- a/docs/models/components/anthropiccachecreation.mdx +++ b/docs/models/components/anthropiccachecreation.mdx @@ -6,5 +6,5 @@ title: "AnthropicCacheCreation" | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `Ephemeral1hInputTokens` | `int64` | :heavy_check_mark: | N/A | -| `Ephemeral5mInputTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Ephemeral1hInputTokens` | `int64` | ✅ | N/A | +| `Ephemeral5mInputTokens` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcharlocation.mdx b/docs/models/components/anthropiccitationcharlocation.mdx index cebeb99f2..9d0470705 100644 --- a/docs/models/components/anthropiccitationcharlocation.mdx +++ b/docs/models/components/anthropiccitationcharlocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationCharLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndCharIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `*string` | :heavy_check_mark: | N/A | -| `StartCharIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationCharLocationType](../../models/components/anthropiccitationcharlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `DocumentIndex` | `int64` | ✅ | N/A | +| `DocumentTitle` | `*string` | ✅ | N/A | +| `EndCharIndex` | `int64` | ✅ | N/A | +| `FileID` | `*string` | ✅ | N/A | +| `StartCharIndex` | `int64` | ✅ | N/A | +| `Type` | [components.AnthropicCitationCharLocationType](../../models/components/anthropiccitationcharlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcharlocationparam.mdx b/docs/models/components/anthropiccitationcharlocationparam.mdx index 98984ed1f..c36e2c0c5 100644 --- a/docs/models/components/anthropiccitationcharlocationparam.mdx +++ b/docs/models/components/anthropiccitationcharlocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationCharLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndCharIndex` | `int64` | :heavy_check_mark: | N/A | -| `StartCharIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationCharLocationParamType](../../models/components/anthropiccitationcharlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `DocumentIndex` | `int64` | ✅ | N/A | +| `DocumentTitle` | `*string` | ✅ | N/A | +| `EndCharIndex` | `int64` | ✅ | N/A | +| `StartCharIndex` | `int64` | ✅ | N/A | +| `Type` | [components.AnthropicCitationCharLocationParamType](../../models/components/anthropiccitationcharlocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcontentblocklocation.mdx b/docs/models/components/anthropiccitationcontentblocklocation.mdx index 9ec31455a..8362cf22e 100644 --- a/docs/models/components/anthropiccitationcontentblocklocation.mdx +++ b/docs/models/components/anthropiccitationcontentblocklocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationContentBlockLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `*string` | :heavy_check_mark: | N/A | -| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationContentBlockLocationType](../../models/components/anthropiccitationcontentblocklocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `DocumentIndex` | `int64` | ✅ | N/A | +| `DocumentTitle` | `*string` | ✅ | N/A | +| `EndBlockIndex` | `int64` | ✅ | N/A | +| `FileID` | `*string` | ✅ | N/A | +| `StartBlockIndex` | `int64` | ✅ | N/A | +| `Type` | [components.AnthropicCitationContentBlockLocationType](../../models/components/anthropiccitationcontentblocklocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcontentblocklocationparam.mdx b/docs/models/components/anthropiccitationcontentblocklocationparam.mdx index 76be2e879..58bf17c2f 100644 --- a/docs/models/components/anthropiccitationcontentblocklocationparam.mdx +++ b/docs/models/components/anthropiccitationcontentblocklocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationContentBlockLocationParam" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationContentBlockLocationParamType](../../models/components/anthropiccitationcontentblocklocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `DocumentIndex` | `int64` | ✅ | N/A | +| `DocumentTitle` | `*string` | ✅ | N/A | +| `EndBlockIndex` | `int64` | ✅ | N/A | +| `StartBlockIndex` | `int64` | ✅ | N/A | +| `Type` | [components.AnthropicCitationContentBlockLocationParamType](../../models/components/anthropiccitationcontentblocklocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationpagelocation.mdx b/docs/models/components/anthropiccitationpagelocation.mdx index 99c4f41f3..e64e79c1c 100644 --- a/docs/models/components/anthropiccitationpagelocation.mdx +++ b/docs/models/components/anthropiccitationpagelocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationPageLocation" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndPageNumber` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `*string` | :heavy_check_mark: | N/A | -| `StartPageNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationPageLocationType](../../models/components/anthropiccitationpagelocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `DocumentIndex` | `int64` | ✅ | N/A | +| `DocumentTitle` | `*string` | ✅ | N/A | +| `EndPageNumber` | `int64` | ✅ | N/A | +| `FileID` | `*string` | ✅ | N/A | +| `StartPageNumber` | `int64` | ✅ | N/A | +| `Type` | [components.AnthropicCitationPageLocationType](../../models/components/anthropiccitationpagelocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationpagelocationparam.mdx b/docs/models/components/anthropiccitationpagelocationparam.mdx index aa8bcb3ca..8b792d493 100644 --- a/docs/models/components/anthropiccitationpagelocationparam.mdx +++ b/docs/models/components/anthropiccitationpagelocationparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicCitationPageLocationParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndPageNumber` | `int64` | :heavy_check_mark: | N/A | -| `StartPageNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationPageLocationParamType](../../models/components/anthropiccitationpagelocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `DocumentIndex` | `int64` | ✅ | N/A | +| `DocumentTitle` | `*string` | ✅ | N/A | +| `EndPageNumber` | `int64` | ✅ | N/A | +| `StartPageNumber` | `int64` | ✅ | N/A | +| `Type` | [components.AnthropicCitationPageLocationParamType](../../models/components/anthropiccitationpagelocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationsconfig.mdx b/docs/models/components/anthropiccitationsconfig.mdx index 54f28d5f3..c4a7215ec 100644 --- a/docs/models/components/anthropiccitationsconfig.mdx +++ b/docs/models/components/anthropiccitationsconfig.mdx @@ -6,4 +6,4 @@ title: "AnthropicCitationsConfig" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Enabled` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Enabled` | `bool` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationsearchresultlocation.mdx b/docs/models/components/anthropiccitationsearchresultlocation.mdx index 5916941fb..e6dba4394 100644 --- a/docs/models/components/anthropiccitationsearchresultlocation.mdx +++ b/docs/models/components/anthropiccitationsearchresultlocation.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationSearchResultLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `SearchResultIndex` | `int64` | :heavy_check_mark: | N/A | -| `Source` | `string` | :heavy_check_mark: | N/A | -| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `Title` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationSearchResultLocationType](../../models/components/anthropiccitationsearchresultlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `EndBlockIndex` | `int64` | ✅ | N/A | +| `SearchResultIndex` | `int64` | ✅ | N/A | +| `Source` | `string` | ✅ | N/A | +| `StartBlockIndex` | `int64` | ✅ | N/A | +| `Title` | `*string` | ✅ | N/A | +| `Type` | [components.AnthropicCitationSearchResultLocationType](../../models/components/anthropiccitationsearchresultlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationsearchresultlocationparam.mdx b/docs/models/components/anthropiccitationsearchresultlocationparam.mdx index 05ae11135..35e524b18 100644 --- a/docs/models/components/anthropiccitationsearchresultlocationparam.mdx +++ b/docs/models/components/anthropiccitationsearchresultlocationparam.mdx @@ -6,10 +6,10 @@ title: "AnthropicCitationSearchResultLocationParam" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `SearchResultIndex` | `int64` | :heavy_check_mark: | N/A | -| `Source` | `string` | :heavy_check_mark: | N/A | -| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `Title` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationSearchResultLocationParamType](../../models/components/anthropiccitationsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `EndBlockIndex` | `int64` | ✅ | N/A | +| `SearchResultIndex` | `int64` | ✅ | N/A | +| `Source` | `string` | ✅ | N/A | +| `StartBlockIndex` | `int64` | ✅ | N/A | +| `Title` | `*string` | ✅ | N/A | +| `Type` | [components.AnthropicCitationSearchResultLocationParamType](../../models/components/anthropiccitationsearchresultlocationparamtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationwebsearchresultlocation.mdx b/docs/models/components/anthropiccitationwebsearchresultlocation.mdx index ffcafe169..0c56e2d2a 100644 --- a/docs/models/components/anthropiccitationwebsearchresultlocation.mdx +++ b/docs/models/components/anthropiccitationwebsearchresultlocation.mdx @@ -6,8 +6,8 @@ title: "AnthropicCitationWebSearchResultLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `EncryptedIndex` | `string` | :heavy_check_mark: | N/A | -| `Title` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationWebSearchResultLocationType](../../models/components/anthropiccitationwebsearchresultlocationtype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `EncryptedIndex` | `string` | ✅ | N/A | +| `Title` | `*string` | ✅ | N/A | +| `Type` | [components.AnthropicCitationWebSearchResultLocationType](../../models/components/anthropiccitationwebsearchresultlocationtype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx b/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx index cb7994873..3b5d7ea3d 100644 --- a/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx +++ b/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx @@ -6,8 +6,8 @@ title: "AnthropicCitationWebSearchResultLocationParam" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `EncryptedIndex` | `string` | :heavy_check_mark: | N/A | -| `Title` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationWebSearchResultLocationParamType](../../models/components/anthropiccitationwebsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `string` | ✅ | N/A | +| `EncryptedIndex` | `string` | ✅ | N/A | +| `Title` | `*string` | ✅ | N/A | +| `Type` | [components.AnthropicCitationWebSearchResultLocationParamType](../../models/components/anthropiccitationwebsearchresultlocationparamtype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecution20250825caller.mdx b/docs/models/components/anthropiccodeexecution20250825caller.mdx index 72eda21ff..bc63b65bf 100644 --- a/docs/models/components/anthropiccodeexecution20250825caller.mdx +++ b/docs/models/components/anthropiccodeexecution20250825caller.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecution20250825Caller" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `ToolID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCodeExecution20250825CallerType](../../models/components/anthropiccodeexecution20250825callertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ToolID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicCodeExecution20250825CallerType](../../models/components/anthropiccodeexecution20250825callertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecution20260120caller.mdx b/docs/models/components/anthropiccodeexecution20260120caller.mdx index 4b36ea291..5bd070a52 100644 --- a/docs/models/components/anthropiccodeexecution20260120caller.mdx +++ b/docs/models/components/anthropiccodeexecution20260120caller.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecution20260120Caller" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `ToolID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCodeExecution20260120CallerType](../../models/components/anthropiccodeexecution20260120callertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ToolID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicCodeExecution20260120CallerType](../../models/components/anthropiccodeexecution20260120callertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecutionoutput.mdx b/docs/models/components/anthropiccodeexecutionoutput.mdx index 442188475..fb5fc50d6 100644 --- a/docs/models/components/anthropiccodeexecutionoutput.mdx +++ b/docs/models/components/anthropiccodeexecutionoutput.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecutionOutput" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCodeExecutionOutputType](../../models/components/anthropiccodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicCodeExecutionOutputType](../../models/components/anthropiccodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecutionresult.mdx b/docs/models/components/anthropiccodeexecutionresult.mdx index d0a75567d..a28b903a8 100644 --- a/docs/models/components/anthropiccodeexecutionresult.mdx +++ b/docs/models/components/anthropiccodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicCodeExecutionResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.AnthropicCodeExecutionOutput](../../models/components/anthropiccodeexecutionoutput.mdx) | :heavy_check_mark: | N/A | -| `ReturnCode` | `int64` | :heavy_check_mark: | N/A | -| `Stderr` | `string` | :heavy_check_mark: | N/A | -| `Stdout` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCodeExecutionResultType](../../models/components/anthropiccodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [][components.AnthropicCodeExecutionOutput](../../models/components/anthropiccodeexecutionoutput.mdx) | ✅ | N/A | +| `ReturnCode` | `int64` | ✅ | N/A | +| `Stderr` | `string` | ✅ | N/A | +| `Stdout` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicCodeExecutionResultType](../../models/components/anthropiccodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecutiontoolresult.mdx b/docs/models/components/anthropiccodeexecutiontoolresult.mdx index fe3ed6725..d9e018d0c 100644 --- a/docs/models/components/anthropiccodeexecutiontoolresult.mdx +++ b/docs/models/components/anthropiccodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicCodeExecutionToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Content` | [components.AnthropicCodeExecutionContent](../../models/components/anthropiccodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicCodeExecutionToolResultType](../../models/components/anthropiccodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicCodeExecutionContent](../../models/components/anthropiccodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | +| `ToolUseID` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicCodeExecutionToolResultType](../../models/components/anthropiccodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccodeexecutiontoolresulterror.mdx b/docs/models/components/anthropiccodeexecutiontoolresulterror.mdx index c0a1af1ba..ab4ee97cf 100644 --- a/docs/models/components/anthropiccodeexecutiontoolresulterror.mdx +++ b/docs/models/components/anthropiccodeexecutiontoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicCodeExecutionToolResultError" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicServerToolErrorCode](../../models/components/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | -| `Type` | [components.AnthropicCodeExecutionToolResultErrorType](../../models/components/anthropiccodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ErrorCode` | [components.AnthropicServerToolErrorCode](../../models/components/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | +| `Type` | [components.AnthropicCodeExecutionToolResultErrorType](../../models/components/anthropiccodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccompactionblock.mdx b/docs/models/components/anthropiccompactionblock.mdx index 1ce70ccfc..60a2c7d40 100644 --- a/docs/models/components/anthropiccompactionblock.mdx +++ b/docs/models/components/anthropiccompactionblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicCompactionBlock" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Content` | `*string` | :heavy_check_mark: | N/A | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.AnthropicCompactionBlockType](../../models/components/anthropiccompactionblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | `*string` | ✅ | N/A | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.AnthropicCompactionBlockType](../../models/components/anthropiccompactionblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccompactionusageiteration.mdx b/docs/models/components/anthropiccompactionusageiteration.mdx index dd4c89650..3c9d0a507 100644 --- a/docs/models/components/anthropiccompactionusageiteration.mdx +++ b/docs/models/components/anthropiccompactionusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicCompactionUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicCompactionUsageIterationType](../../models/components/anthropiccompactionusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreationInputTokens` | `*int64` | ➖ | N/A | | +| `CacheReadInputTokens` | `*int64` | ➖ | N/A | | +| `InputTokens` | `*int64` | ➖ | N/A | | +| `OutputTokens` | `*int64` | ➖ | N/A | | +| `Type` | [components.AnthropicCompactionUsageIterationType](../../models/components/anthropiccompactionusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccontainer.mdx b/docs/models/components/anthropiccontainer.mdx index 2cdc5ab7a..3a5756b6d 100644 --- a/docs/models/components/anthropiccontainer.mdx +++ b/docs/models/components/anthropiccontainer.mdx @@ -6,6 +6,6 @@ title: "AnthropicContainer" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `ExpiresAt` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Skills` | optionalnullable.OptionalNullable[[][components.AnthropicContainerSkill](../../models/components/anthropiccontainerskill.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ExpiresAt` | `string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Skills` | optionalnullable.OptionalNullable[[][components.AnthropicContainerSkill](../../models/components/anthropiccontainerskill.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccontainerskill.mdx b/docs/models/components/anthropiccontainerskill.mdx index 68f4fe1a6..0c893ccda 100644 --- a/docs/models/components/anthropiccontainerskill.mdx +++ b/docs/models/components/anthropiccontainerskill.mdx @@ -6,6 +6,6 @@ title: "AnthropicContainerSkill" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `SkillID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicContainerSkillType](../../models/components/anthropiccontainerskilltype.mdx) | :heavy_check_mark: | N/A | -| `Version` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `SkillID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicContainerSkillType](../../models/components/anthropiccontainerskilltype.mdx) | ✅ | N/A | +| `Version` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccontainerupload.mdx b/docs/models/components/anthropiccontainerupload.mdx index 63fc64996..63b89f4ea 100644 --- a/docs/models/components/anthropiccontainerupload.mdx +++ b/docs/models/components/anthropiccontainerupload.mdx @@ -6,5 +6,5 @@ title: "AnthropicContainerUpload" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicContainerUploadType](../../models/components/anthropiccontaineruploadtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicContainerUploadType](../../models/components/anthropiccontaineruploadtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicdirectcaller.mdx b/docs/models/components/anthropicdirectcaller.mdx index 7c1fce85a..c2f48f738 100644 --- a/docs/models/components/anthropicdirectcaller.mdx +++ b/docs/models/components/anthropicdirectcaller.mdx @@ -6,4 +6,4 @@ title: "AnthropicDirectCaller" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicDirectCallerType](../../models/components/anthropicdirectcallertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicDirectCallerType](../../models/components/anthropicdirectcallertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicdocumentblock.mdx b/docs/models/components/anthropicdocumentblock.mdx index bebd292e3..4ebf70d52 100644 --- a/docs/models/components/anthropicdocumentblock.mdx +++ b/docs/models/components/anthropicdocumentblock.mdx @@ -6,7 +6,7 @@ title: "AnthropicDocumentBlock" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicCitationsConfig](../../models/components/anthropiccitationsconfig.mdx)] | :heavy_minus_sign: | N/A | \{
"enabled": true
} | -| `Source` | [components.AnthropicDocumentBlockSource](../../models/components/anthropicdocumentblocksource.mdx) | :heavy_check_mark: | N/A | | -| `Title` | `*string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicDocumentBlockType](../../models/components/anthropicdocumentblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicCitationsConfig](../../models/components/anthropiccitationsconfig.mdx)] | ➖ | N/A | \{
"enabled": true
} | +| `Source` | [components.AnthropicDocumentBlockSource](../../models/components/anthropicdocumentblocksource.mdx) | ✅ | N/A | | +| `Title` | `*string` | ✅ | N/A | | +| `Type` | [components.AnthropicDocumentBlockType](../../models/components/anthropicdocumentblocktype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicdocumentblockparam.mdx b/docs/models/components/anthropicdocumentblockparam.mdx index 6f957394d..0f79f0bae 100644 --- a/docs/models/components/anthropicdocumentblockparam.mdx +++ b/docs/models/components/anthropicdocumentblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicDocumentBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicDocumentBlockParamCitations](../../models/components/anthropicdocumentblockparamcitations.mdx)] | :heavy_minus_sign: | N/A | | -| `Context` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Source` | [components.AnthropicDocumentBlockParamSourceUnion](../../models/components/anthropicdocumentblockparamsourceunion.mdx) | :heavy_check_mark: | N/A | | -| `Title` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicDocumentBlockParamTypeDocument](../../models/components/anthropicdocumentblockparamtypedocument.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicDocumentBlockParamCitations](../../models/components/anthropicdocumentblockparamcitations.mdx)] | ➖ | N/A | | +| `Context` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Source` | [components.AnthropicDocumentBlockParamSourceUnion](../../models/components/anthropicdocumentblockparamsourceunion.mdx) | ✅ | N/A | | +| `Title` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Type` | [components.AnthropicDocumentBlockParamTypeDocument](../../models/components/anthropicdocumentblockparamtypedocument.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicdocumentblockparamcitations.mdx b/docs/models/components/anthropicdocumentblockparamcitations.mdx index 4aa238324..02eff1971 100644 --- a/docs/models/components/anthropicdocumentblockparamcitations.mdx +++ b/docs/models/components/anthropicdocumentblockparamcitations.mdx @@ -6,4 +6,4 @@ title: "AnthropicDocumentBlockParamCitations" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicencryptedcodeexecutionresult.mdx b/docs/models/components/anthropicencryptedcodeexecutionresult.mdx index f40f74b89..b876203f4 100644 --- a/docs/models/components/anthropicencryptedcodeexecutionresult.mdx +++ b/docs/models/components/anthropicencryptedcodeexecutionresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicEncryptedCodeExecutionResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.AnthropicCodeExecutionOutput](../../models/components/anthropiccodeexecutionoutput.mdx) | :heavy_check_mark: | N/A | -| `EncryptedStdout` | `string` | :heavy_check_mark: | N/A | -| `ReturnCode` | `int64` | :heavy_check_mark: | N/A | -| `Stderr` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicEncryptedCodeExecutionResultType](../../models/components/anthropicencryptedcodeexecutionresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [][components.AnthropicCodeExecutionOutput](../../models/components/anthropiccodeexecutionoutput.mdx) | ✅ | N/A | +| `EncryptedStdout` | `string` | ✅ | N/A | +| `ReturnCode` | `int64` | ✅ | N/A | +| `Stderr` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicEncryptedCodeExecutionResultType](../../models/components/anthropicencryptedcodeexecutionresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfile.mdx b/docs/models/components/anthropicfile.mdx index df8cc5a0b..608f8ac0b 100644 --- a/docs/models/components/anthropicfile.mdx +++ b/docs/models/components/anthropicfile.mdx @@ -9,11 +9,11 @@ A stored file in Anthropic's Files API shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Shape` | [components.AnthropicFileShape](../../models/components/anthropicfileshape.mdx) | :heavy_check_mark: | N/A | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | -| `Downloadable` | `bool` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `MimeType` | `string` | :heavy_check_mark: | N/A | -| `SizeBytes` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicFileType](../../models/components/anthropicfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.AnthropicFileShape](../../models/components/anthropicfileshape.mdx) | ✅ | N/A | +| `CreatedAt` | `string` | ✅ | N/A | +| `Downloadable` | `bool` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `MimeType` | `string` | ✅ | N/A | +| `SizeBytes` | `int64` | ✅ | N/A | +| `Type` | [components.AnthropicFileType](../../models/components/anthropicfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfiledeleted.mdx b/docs/models/components/anthropicfiledeleted.mdx index e62527293..ccbdc8793 100644 --- a/docs/models/components/anthropicfiledeleted.mdx +++ b/docs/models/components/anthropicfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in Anthropic's shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Shape` | [components.AnthropicFileDeletedShape](../../models/components/anthropicfiledeletedshape.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicFileDeletedType](../../models/components/anthropicfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.AnthropicFileDeletedShape](../../models/components/anthropicfiledeletedshape.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicFileDeletedType](../../models/components/anthropicfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfiledocumentsource.mdx b/docs/models/components/anthropicfiledocumentsource.mdx index 232e3fd8c..98a6f3787 100644 --- a/docs/models/components/anthropicfiledocumentsource.mdx +++ b/docs/models/components/anthropicfiledocumentsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicFileDocumentSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicFileDocumentSourceType](../../models/components/anthropicfiledocumentsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicFileDocumentSourceType](../../models/components/anthropicfiledocumentsourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfilelist.mdx b/docs/models/components/anthropicfilelist.mdx index f8c77f70d..ec78228a9 100644 --- a/docs/models/components/anthropicfilelist.mdx +++ b/docs/models/components/anthropicfilelist.mdx @@ -9,8 +9,8 @@ A page of files in Anthropic's shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Shape` | [components.AnthropicFileListShape](../../models/components/anthropicfilelistshape.mdx) | :heavy_check_mark: | N/A | -| `Data` | [][components.AnthropicFile](../../models/components/anthropicfile.mdx) | :heavy_check_mark: | N/A | -| `FirstID` | `*string` | :heavy_check_mark: | N/A | -| `HasMore` | `bool` | :heavy_check_mark: | N/A | -| `LastID` | `*string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.AnthropicFileListShape](../../models/components/anthropicfilelistshape.mdx) | ✅ | N/A | +| `Data` | [][components.AnthropicFile](../../models/components/anthropicfile.mdx) | ✅ | N/A | +| `FirstID` | `*string` | ✅ | N/A | +| `HasMore` | `bool` | ✅ | N/A | +| `LastID` | `*string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicimageblockparam.mdx b/docs/models/components/anthropicimageblockparam.mdx index 55384b6a6..8e051054f 100644 --- a/docs/models/components/anthropicimageblockparam.mdx +++ b/docs/models/components/anthropicimageblockparam.mdx @@ -6,6 +6,6 @@ title: "AnthropicImageBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Source` | [components.AnthropicImageBlockParamSource](../../models/components/anthropicimageblockparamsource.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicImageBlockParamType](../../models/components/anthropicimageblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Source` | [components.AnthropicImageBlockParamSource](../../models/components/anthropicimageblockparamsource.mdx) | ✅ | N/A | | +| `Type` | [components.AnthropicImageBlockParamType](../../models/components/anthropicimageblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicinputtokensclearatleast.mdx b/docs/models/components/anthropicinputtokensclearatleast.mdx index 4f0705672..be72bd1cd 100644 --- a/docs/models/components/anthropicinputtokensclearatleast.mdx +++ b/docs/models/components/anthropicinputtokensclearatleast.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensClearAtLeast" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.AnthropicInputTokensClearAtLeastType](../../models/components/anthropicinputtokensclearatleasttype.mdx) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicInputTokensClearAtLeastType](../../models/components/anthropicinputtokensclearatleasttype.mdx) | ✅ | N/A | +| `Value` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicinputtokenstrigger.mdx b/docs/models/components/anthropicinputtokenstrigger.mdx index 30868cc63..8320f5f09 100644 --- a/docs/models/components/anthropicinputtokenstrigger.mdx +++ b/docs/models/components/anthropicinputtokenstrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensTrigger" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicInputTokensTriggerType](../../models/components/anthropicinputtokenstriggertype.mdx) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicInputTokensTriggerType](../../models/components/anthropicinputtokenstriggertype.mdx) | ✅ | N/A | +| `Value` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicinputtransformation.mdx b/docs/models/components/anthropicinputtransformation.mdx index ae0ffff19..e29a5d8ab 100644 --- a/docs/models/components/anthropicinputtransformation.mdx +++ b/docs/models/components/anthropicinputtransformation.mdx @@ -9,7 +9,7 @@ A server-side transformation Anthropic applied to the request input | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Path` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Reason` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | `string` | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"path": "messages.1.content.0",
"reason": "prefix_binding_mismatch",
"type": "thinking_dropped"
} | \ No newline at end of file +| `Path` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Reason` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Type` | `string` | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"path": "messages.1.content.0",
"reason": "prefix_binding_mismatch",
"type": "thinking_dropped"
} | \ No newline at end of file diff --git a/docs/models/components/anthropiciterationcachecreation.mdx b/docs/models/components/anthropiciterationcachecreation.mdx index 7fdb64675..f4af68401 100644 --- a/docs/models/components/anthropiciterationcachecreation.mdx +++ b/docs/models/components/anthropiciterationcachecreation.mdx @@ -6,5 +6,5 @@ title: "AnthropicIterationCacheCreation" | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `Ephemeral1hInputTokens` | `*int64` | :heavy_minus_sign: | N/A | -| `Ephemeral5mInputTokens` | `*int64` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Ephemeral1hInputTokens` | `*int64` | ➖ | N/A | +| `Ephemeral5mInputTokens` | `*int64` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicmessageoutputconfig.mdx b/docs/models/components/anthropicmessageoutputconfig.mdx index 22e658d83..25a69ab66 100644 --- a/docs/models/components/anthropicmessageoutputconfig.mdx +++ b/docs/models/components/anthropicmessageoutputconfig.mdx @@ -6,4 +6,4 @@ title: "AnthropicMessageOutputConfig" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.AnthropicOutputEffort](../../models/components/anthropicoutputeffort.mdx)] | :heavy_minus_sign: | N/A | high | \ No newline at end of file +| `Effort` | optionalnullable.OptionalNullable[[components.AnthropicOutputEffort](../../models/components/anthropicoutputeffort.mdx)] | ➖ | N/A | high | \ No newline at end of file diff --git a/docs/models/components/anthropicmessageusageiteration.mdx b/docs/models/components/anthropicmessageusageiteration.mdx index 7def35867..c7adf3e10 100644 --- a/docs/models/components/anthropicmessageusageiteration.mdx +++ b/docs/models/components/anthropicmessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicMessageUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `Model` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicMessageUsageIterationType](../../models/components/anthropicmessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreationInputTokens` | `*int64` | ➖ | N/A | | +| `CacheReadInputTokens` | `*int64` | ➖ | N/A | | +| `InputTokens` | `*int64` | ➖ | N/A | | +| `OutputTokens` | `*int64` | ➖ | N/A | | +| `Model` | `*string` | ➖ | N/A | | +| `Type` | [components.AnthropicMessageUsageIterationType](../../models/components/anthropicmessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicoutputtokensdetails.mdx b/docs/models/components/anthropicoutputtokensdetails.mdx index de80847b3..06792e4ca 100644 --- a/docs/models/components/anthropicoutputtokensdetails.mdx +++ b/docs/models/components/anthropicoutputtokensdetails.mdx @@ -6,4 +6,4 @@ title: "AnthropicOutputTokensDetails" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ThinkingTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `ThinkingTokens` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicplaintextsource.mdx b/docs/models/components/anthropicplaintextsource.mdx index 0f8ee421e..ae1510610 100644 --- a/docs/models/components/anthropicplaintextsource.mdx +++ b/docs/models/components/anthropicplaintextsource.mdx @@ -6,6 +6,6 @@ title: "AnthropicPlainTextSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `MediaType` | [components.AnthropicPlainTextSourceMediaType](../../models/components/anthropicplaintextsourcemediatype.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicPlainTextSourceType](../../models/components/anthropicplaintextsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | `string` | ✅ | N/A | +| `MediaType` | [components.AnthropicPlainTextSourceMediaType](../../models/components/anthropicplaintextsourcemediatype.mdx) | ✅ | N/A | +| `Type` | [components.AnthropicPlainTextSourceType](../../models/components/anthropicplaintextsourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicredactedthinkingblock.mdx b/docs/models/components/anthropicredactedthinkingblock.mdx index 035853211..0d1aa5811 100644 --- a/docs/models/components/anthropicredactedthinkingblock.mdx +++ b/docs/models/components/anthropicredactedthinkingblock.mdx @@ -6,5 +6,5 @@ title: "AnthropicRedactedThinkingBlock" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicRedactedThinkingBlockType](../../models/components/anthropicredactedthinkingblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicRedactedThinkingBlockType](../../models/components/anthropicredactedthinkingblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicrefusalstopdetails.mdx b/docs/models/components/anthropicrefusalstopdetails.mdx index ce99e643c..a7b330eed 100644 --- a/docs/models/components/anthropicrefusalstopdetails.mdx +++ b/docs/models/components/anthropicrefusalstopdetails.mdx @@ -9,6 +9,6 @@ Structured information about a refusal | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Category` | [*components.AnthropicRefusalStopDetailsCategory](../../models/components/anthropicrefusalstopdetailscategory.mdx) | :heavy_check_mark: | N/A | -| `Explanation` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicRefusalStopDetailsType](../../models/components/anthropicrefusalstopdetailstype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Category` | [*components.AnthropicRefusalStopDetailsCategory](../../models/components/anthropicrefusalstopdetailscategory.mdx) | ✅ | N/A | +| `Explanation` | `*string` | ✅ | N/A | +| `Type` | [components.AnthropicRefusalStopDetailsType](../../models/components/anthropicrefusalstopdetailstype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicsafeguard.mdx b/docs/models/components/anthropicsafeguard.mdx index 71b1f6962..9765226e6 100644 --- a/docs/models/components/anthropicsafeguard.mdx +++ b/docs/models/components/anthropicsafeguard.mdx @@ -9,6 +9,6 @@ A server-side safeguard Anthropic evaluates alongside the completion | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `ClassifierContext` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `Type` | `string` | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file +| `ClassifierContext` | map[string]`any` | ➖ | N/A | | +| `Type` | `string` | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file diff --git a/docs/models/components/anthropicsearchresultblockparam.mdx b/docs/models/components/anthropicsearchresultblockparam.mdx index 8cfe7f426..5dd5d5076 100644 --- a/docs/models/components/anthropicsearchresultblockparam.mdx +++ b/docs/models/components/anthropicsearchresultblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicSearchResultBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Citations` | [*components.AnthropicSearchResultBlockParamCitations](../../models/components/anthropicsearchresultblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | -| `Content` | [][components.AnthropicTextBlockParam](../../models/components/anthropictextblockparam.mdx) | :heavy_check_mark: | N/A | | -| `Source` | `string` | :heavy_check_mark: | N/A | | -| `Title` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicSearchResultBlockParamType](../../models/components/anthropicsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Citations` | [*components.AnthropicSearchResultBlockParamCitations](../../models/components/anthropicsearchresultblockparamcitations.mdx) | ➖ | N/A | | +| `Content` | [][components.AnthropicTextBlockParam](../../models/components/anthropictextblockparam.mdx) | ✅ | N/A | | +| `Source` | `string` | ✅ | N/A | | +| `Title` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicSearchResultBlockParamType](../../models/components/anthropicsearchresultblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicsearchresultblockparamcitations.mdx b/docs/models/components/anthropicsearchresultblockparamcitations.mdx index 9fa5367e2..8c1f5c80c 100644 --- a/docs/models/components/anthropicsearchresultblockparamcitations.mdx +++ b/docs/models/components/anthropicsearchresultblockparamcitations.mdx @@ -6,4 +6,4 @@ title: "AnthropicSearchResultBlockParamCitations" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicservertoolusage.mdx b/docs/models/components/anthropicservertoolusage.mdx index 7a7c328f8..be89ac940 100644 --- a/docs/models/components/anthropicservertoolusage.mdx +++ b/docs/models/components/anthropicservertoolusage.mdx @@ -6,5 +6,5 @@ title: "AnthropicServerToolUsage" | Field | Type | Required | Description | | ------------------- | ------------------- | ------------------- | ------------------- | -| `WebFetchRequests` | `int64` | :heavy_check_mark: | N/A | -| `WebSearchRequests` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `WebFetchRequests` | `int64` | ✅ | N/A | +| `WebSearchRequests` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictextblock.mdx b/docs/models/components/anthropictextblock.mdx index ad05e22a0..0cfb070ce 100644 --- a/docs/models/components/anthropictextblock.mdx +++ b/docs/models/components/anthropictextblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextBlock" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Citations` | [][components.AnthropicTextCitation](../../models/components/anthropictextcitation.mdx) | :heavy_check_mark: | N/A | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicTextBlockType](../../models/components/anthropictextblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Citations` | [][components.AnthropicTextCitation](../../models/components/anthropictextcitation.mdx) | ✅ | N/A | +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicTextBlockType](../../models/components/anthropictextblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictextblockparam.mdx b/docs/models/components/anthropictextblockparam.mdx index 7bc465cea..aa581b33e 100644 --- a/docs/models/components/anthropictextblockparam.mdx +++ b/docs/models/components/anthropictextblockparam.mdx @@ -6,7 +6,7 @@ title: "AnthropicTextBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Citations` | optionalnullable.OptionalNullable[[][components.Citation](../../models/components/citation.mdx)] | :heavy_minus_sign: | N/A | | -| `Text` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicTextBlockParamType](../../models/components/anthropictextblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Citations` | optionalnullable.OptionalNullable[[][components.Citation](../../models/components/citation.mdx)] | ➖ | N/A | | +| `Text` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicTextBlockParamType](../../models/components/anthropictextblockparamtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutioncreateresult.mdx b/docs/models/components/anthropictexteditorcodeexecutioncreateresult.mdx index 3e0667901..71b7c2af3 100644 --- a/docs/models/components/anthropictexteditorcodeexecutioncreateresult.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutioncreateresult.mdx @@ -6,5 +6,5 @@ title: "AnthropicTextEditorCodeExecutionCreateResult" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `IsFileUpdate` | `bool` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicTextEditorCodeExecutionCreateResultType](../../models/components/anthropictexteditorcodeexecutioncreateresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `IsFileUpdate` | `bool` | ✅ | N/A | +| `Type` | [components.AnthropicTextEditorCodeExecutionCreateResultType](../../models/components/anthropictexteditorcodeexecutioncreateresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx b/docs/models/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx index 5b07e0ae0..e712e39f4 100644 --- a/docs/models/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutionstrreplaceresult.mdx @@ -6,9 +6,9 @@ title: "AnthropicTextEditorCodeExecutionStrReplaceResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Lines` | []`string` | :heavy_check_mark: | N/A | -| `NewLines` | `*int64` | :heavy_check_mark: | N/A | -| `NewStart` | `*int64` | :heavy_check_mark: | N/A | -| `OldLines` | `*int64` | :heavy_check_mark: | N/A | -| `OldStart` | `*int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicTextEditorCodeExecutionStrReplaceResultType](../../models/components/anthropictexteditorcodeexecutionstrreplaceresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Lines` | []`string` | ✅ | N/A | +| `NewLines` | `*int64` | ✅ | N/A | +| `NewStart` | `*int64` | ✅ | N/A | +| `OldLines` | `*int64` | ✅ | N/A | +| `OldStart` | `*int64` | ✅ | N/A | +| `Type` | [components.AnthropicTextEditorCodeExecutionStrReplaceResultType](../../models/components/anthropictexteditorcodeexecutionstrreplaceresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutiontoolresult.mdx b/docs/models/components/anthropictexteditorcodeexecutiontoolresult.mdx index 667cf9976..1565dac1f 100644 --- a/docs/models/components/anthropictexteditorcodeexecutiontoolresult.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutiontoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextEditorCodeExecutionToolResult" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicTextEditorCodeExecutionContent](../../models/components/anthropictexteditorcodeexecutioncontent.mdx) | :heavy_check_mark: | N/A | \{
"content": "file content",
"file_type": "text",
"num_lines": 10,
"start_line": 1,
"total_lines": 10,
"type": "text_editor_code_execution_view_result"
} | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicTextEditorCodeExecutionToolResultType](../../models/components/anthropictexteditorcodeexecutiontoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicTextEditorCodeExecutionContent](../../models/components/anthropictexteditorcodeexecutioncontent.mdx) | ✅ | N/A | \{
"content": "file content",
"file_type": "text",
"num_lines": 10,
"start_line": 1,
"total_lines": 10,
"type": "text_editor_code_execution_view_result"
} | +| `ToolUseID` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicTextEditorCodeExecutionToolResultType](../../models/components/anthropictexteditorcodeexecutiontoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutiontoolresulterror.mdx b/docs/models/components/anthropictexteditorcodeexecutiontoolresulterror.mdx index b0fec48eb..1759f49f8 100644 --- a/docs/models/components/anthropictexteditorcodeexecutiontoolresulterror.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutiontoolresulterror.mdx @@ -6,6 +6,6 @@ title: "AnthropicTextEditorCodeExecutionToolResultError" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../../models/components/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `ErrorMessage` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicTextEditorCodeExecutionToolResultErrorType](../../models/components/anthropictexteditorcodeexecutiontoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ErrorCode` | [components.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../../models/components/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `ErrorMessage` | `*string` | ✅ | N/A | +| `Type` | [components.AnthropicTextEditorCodeExecutionToolResultErrorType](../../models/components/anthropictexteditorcodeexecutiontoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictexteditorcodeexecutionviewresult.mdx b/docs/models/components/anthropictexteditorcodeexecutionviewresult.mdx index 02c45a0bf..9dcbc9888 100644 --- a/docs/models/components/anthropictexteditorcodeexecutionviewresult.mdx +++ b/docs/models/components/anthropictexteditorcodeexecutionviewresult.mdx @@ -6,9 +6,9 @@ title: "AnthropicTextEditorCodeExecutionViewResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | `string` | :heavy_check_mark: | N/A | -| `FileType` | [components.AnthropicTextEditorCodeExecutionViewResultFileType](../../models/components/anthropictexteditorcodeexecutionviewresultfiletype.mdx) | :heavy_check_mark: | N/A | -| `NumLines` | `*int64` | :heavy_check_mark: | N/A | -| `StartLine` | `*int64` | :heavy_check_mark: | N/A | -| `TotalLines` | `*int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicTextEditorCodeExecutionViewResultType](../../models/components/anthropictexteditorcodeexecutionviewresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | `string` | ✅ | N/A | +| `FileType` | [components.AnthropicTextEditorCodeExecutionViewResultFileType](../../models/components/anthropictexteditorcodeexecutionviewresultfiletype.mdx) | ✅ | N/A | +| `NumLines` | `*int64` | ✅ | N/A | +| `StartLine` | `*int64` | ✅ | N/A | +| `TotalLines` | `*int64` | ✅ | N/A | +| `Type` | [components.AnthropicTextEditorCodeExecutionViewResultType](../../models/components/anthropictexteditorcodeexecutionviewresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicthinkingblock.mdx b/docs/models/components/anthropicthinkingblock.mdx index c5dbf107e..02a919310 100644 --- a/docs/models/components/anthropicthinkingblock.mdx +++ b/docs/models/components/anthropicthinkingblock.mdx @@ -6,6 +6,6 @@ title: "AnthropicThinkingBlock" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Signature` | `string` | :heavy_check_mark: | N/A | -| `Thinking` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicThinkingBlockType](../../models/components/anthropicthinkingblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Signature` | `string` | ✅ | N/A | +| `Thinking` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicThinkingBlockType](../../models/components/anthropicthinkingblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicthinkingblockbinding.mdx b/docs/models/components/anthropicthinkingblockbinding.mdx index b372a70e1..f0e8a03d2 100644 --- a/docs/models/components/anthropicthinkingblockbinding.mdx +++ b/docs/models/components/anthropicthinkingblockbinding.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingBlockBinding" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ~~`MismatchBehavior`~~ | optionalnullable.OptionalNullable[[components.MismatchBehavior](../../models/components/mismatchbehavior.mdx)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. | -| `PrefixMismatchBehavior` | optionalnullable.OptionalNullable[[components.PrefixMismatchBehavior](../../models/components/prefixmismatchbehavior.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| ~~`MismatchBehavior`~~ | optionalnullable.OptionalNullable[[components.MismatchBehavior](../../models/components/mismatchbehavior.mdx)] | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. | +| `PrefixMismatchBehavior` | optionalnullable.OptionalNullable[[components.PrefixMismatchBehavior](../../models/components/prefixmismatchbehavior.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicthinkingturns.mdx b/docs/models/components/anthropicthinkingturns.mdx index 81a629801..bc2df8200 100644 --- a/docs/models/components/anthropicthinkingturns.mdx +++ b/docs/models/components/anthropicthinkingturns.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingTurns" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicThinkingTurnsType](../../models/components/anthropicthinkingturnstype.mdx) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicThinkingTurnsType](../../models/components/anthropicthinkingturnstype.mdx) | ✅ | N/A | +| `Value` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolreference.mdx b/docs/models/components/anthropictoolreference.mdx index 42339f5f1..ced1608ad 100644 --- a/docs/models/components/anthropictoolreference.mdx +++ b/docs/models/components/anthropictoolreference.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ToolName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicToolReferenceType](../../models/components/anthropictoolreferencetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ToolName` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicToolReferenceType](../../models/components/anthropictoolreferencetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchresult.mdx b/docs/models/components/anthropictoolsearchresult.mdx index 83619a5fa..665607078 100644 --- a/docs/models/components/anthropictoolsearchresult.mdx +++ b/docs/models/components/anthropictoolsearchresult.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolSearchResult" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ToolReferences` | [][components.AnthropicToolReference](../../models/components/anthropictoolreference.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicToolSearchResultType](../../models/components/anthropictoolsearchresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ToolReferences` | [][components.AnthropicToolReference](../../models/components/anthropictoolreference.mdx) | ✅ | N/A | +| `Type` | [components.AnthropicToolSearchResultType](../../models/components/anthropictoolsearchresulttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchresulterror.mdx b/docs/models/components/anthropictoolsearchresulterror.mdx index c3d0c9f5e..e8e41e10a 100644 --- a/docs/models/components/anthropictoolsearchresulterror.mdx +++ b/docs/models/components/anthropictoolsearchresulterror.mdx @@ -6,6 +6,6 @@ title: "AnthropicToolSearchResultError" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicServerToolErrorCode](../../models/components/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | -| `ErrorMessage` | `*string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicToolSearchResultErrorType](../../models/components/anthropictoolsearchresulterrortype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ErrorCode` | [components.AnthropicServerToolErrorCode](../../models/components/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | +| `ErrorMessage` | `*string` | ✅ | N/A | | +| `Type` | [components.AnthropicToolSearchResultErrorType](../../models/components/anthropictoolsearchresulterrortype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchtoolbm25.mdx b/docs/models/components/anthropictoolsearchtoolbm25.mdx index a9c53b68e..6989bf48e 100644 --- a/docs/models/components/anthropictoolsearchtoolbm25.mdx +++ b/docs/models/components/anthropictoolsearchtoolbm25.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolBm25" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | -| `Name` | [components.AnthropicToolSearchToolBm25Name](../../models/components/anthropictoolsearchtoolbm25name.mdx) | :heavy_check_mark: | N/A | | -| `Strict` | `*bool` | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicToolSearchToolBm25Type](../../models/components/anthropictoolsearchtoolbm25type.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | ➖ | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `DeferLoading` | `*bool` | ➖ | N/A | | +| `Name` | [components.AnthropicToolSearchToolBm25Name](../../models/components/anthropictoolsearchtoolbm25name.mdx) | ✅ | N/A | | +| `Strict` | `*bool` | ➖ | N/A | | +| `Type` | [components.AnthropicToolSearchToolBm25Type](../../models/components/anthropictoolsearchtoolbm25type.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchtoolregex.mdx b/docs/models/components/anthropictoolsearchtoolregex.mdx index 7955aafda..0fb649a00 100644 --- a/docs/models/components/anthropictoolsearchtoolregex.mdx +++ b/docs/models/components/anthropictoolsearchtoolregex.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolRegex" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | -| `Name` | [components.AnthropicToolSearchToolRegexName](../../models/components/anthropictoolsearchtoolregexname.mdx) | :heavy_check_mark: | N/A | | -| `Strict` | `*bool` | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicToolSearchToolRegexType](../../models/components/anthropictoolsearchtoolregextype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | ➖ | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `DeferLoading` | `*bool` | ➖ | N/A | | +| `Name` | [components.AnthropicToolSearchToolRegexName](../../models/components/anthropictoolsearchtoolregexname.mdx) | ✅ | N/A | | +| `Strict` | `*bool` | ➖ | N/A | | +| `Type` | [components.AnthropicToolSearchToolRegexType](../../models/components/anthropictoolsearchtoolregextype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchtoolresult.mdx b/docs/models/components/anthropictoolsearchtoolresult.mdx index a8ff6e164..170917f8b 100644 --- a/docs/models/components/anthropictoolsearchtoolresult.mdx +++ b/docs/models/components/anthropictoolsearchtoolresult.mdx @@ -6,6 +6,6 @@ title: "AnthropicToolSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicToolSearchContent](../../models/components/anthropictoolsearchcontent.mdx) | :heavy_check_mark: | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicToolSearchToolResultType](../../models/components/anthropictoolsearchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicToolSearchContent](../../models/components/anthropictoolsearchcontent.mdx) | ✅ | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | +| `ToolUseID` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicToolSearchToolResultType](../../models/components/anthropictoolsearchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictooluseblock.mdx b/docs/models/components/anthropictooluseblock.mdx index 2c922b09b..9d2c4297a 100644 --- a/docs/models/components/anthropictooluseblock.mdx +++ b/docs/models/components/anthropictooluseblock.mdx @@ -6,8 +6,8 @@ title: "AnthropicToolUseBlock" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Input` | `any` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicToolUseBlockType](../../models/components/anthropictooluseblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | +| `ID` | `string` | ✅ | N/A | | +| `Input` | `any` | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicToolUseBlockType](../../models/components/anthropictooluseblocktype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictooluseskeep.mdx b/docs/models/components/anthropictooluseskeep.mdx index aa7dcff64..6ec63c0fd 100644 --- a/docs/models/components/anthropictooluseskeep.mdx +++ b/docs/models/components/anthropictooluseskeep.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesKeep" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicToolUsesKeepType](../../models/components/anthropictooluseskeeptype.mdx) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicToolUsesKeepType](../../models/components/anthropictooluseskeeptype.mdx) | ✅ | N/A | +| `Value` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolusestrigger.mdx b/docs/models/components/anthropictoolusestrigger.mdx index 5c288271f..f870871c0 100644 --- a/docs/models/components/anthropictoolusestrigger.mdx +++ b/docs/models/components/anthropictoolusestrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesTrigger" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicToolUsesTriggerType](../../models/components/anthropictoolusestriggertype.mdx) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicToolUsesTriggerType](../../models/components/anthropictoolusestriggertype.mdx) | ✅ | N/A | +| `Value` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicunknownusageiteration.mdx b/docs/models/components/anthropicunknownusageiteration.mdx index bbe04bc10..3e42011d3 100644 --- a/docs/models/components/anthropicunknownusageiteration.mdx +++ b/docs/models/components/anthropicunknownusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicUnknownUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `Type` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreationInputTokens` | `*int64` | ➖ | N/A | | +| `CacheReadInputTokens` | `*int64` | ➖ | N/A | | +| `InputTokens` | `*int64` | ➖ | N/A | | +| `OutputTokens` | `*int64` | ➖ | N/A | | +| `Type` | `string` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicurlimagesource.mdx b/docs/models/components/anthropicurlimagesource.mdx index 6c06a3802..5730f3059 100644 --- a/docs/models/components/anthropicurlimagesource.mdx +++ b/docs/models/components/anthropicurlimagesource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLImageSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Type` | [components.AnthropicURLImageSourceType](../../models/components/anthropicurlimagesourcetype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicURLImageSourceType](../../models/components/anthropicurlimagesourcetype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicurlpdfsource.mdx b/docs/models/components/anthropicurlpdfsource.mdx index 20ac41425..5fc61ebf2 100644 --- a/docs/models/components/anthropicurlpdfsource.mdx +++ b/docs/models/components/anthropicurlpdfsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLPdfSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicURLPdfSourceType](../../models/components/anthropicurlpdfsourcetype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicURLPdfSourceType](../../models/components/anthropicurlpdfsourcetype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebfetchblock.mdx b/docs/models/components/anthropicwebfetchblock.mdx index ad112c2cc..e5e7b9898 100644 --- a/docs/models/components/anthropicwebfetchblock.mdx +++ b/docs/models/components/anthropicwebfetchblock.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebFetchBlock" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicDocumentBlock](../../models/components/anthropicdocumentblock.mdx) | :heavy_check_mark: | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | -| `RetrievedAt` | `*string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicWebFetchBlockType](../../models/components/anthropicwebfetchblocktype.mdx) | :heavy_check_mark: | N/A | | -| `URL` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [components.AnthropicDocumentBlock](../../models/components/anthropicdocumentblock.mdx) | ✅ | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | +| `RetrievedAt` | `*string` | ✅ | N/A | | +| `Type` | [components.AnthropicWebFetchBlockType](../../models/components/anthropicwebfetchblocktype.mdx) | ✅ | N/A | | +| `URL` | `string` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicwebfetchtoolresult.mdx b/docs/models/components/anthropicwebfetchtoolresult.mdx index 32c8c00e3..b3741a480 100644 --- a/docs/models/components/anthropicwebfetchtoolresult.mdx +++ b/docs/models/components/anthropicwebfetchtoolresult.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebFetchToolResult" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `Content` | [components.AnthropicWebFetchContent](../../models/components/anthropicwebfetchcontent.mdx) | :heavy_check_mark: | N/A | \{
"content": \{
"citations": null,
"source": \{
"data": "",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
},
"retrieved_at": null,
"type": "web_fetch_result",
"url": "https://example.com"
} | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicWebFetchToolResultType](../../models/components/anthropicwebfetchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | +| `Content` | [components.AnthropicWebFetchContent](../../models/components/anthropicwebfetchcontent.mdx) | ✅ | N/A | \{
"content": \{
"citations": null,
"source": \{
"data": "",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
},
"retrieved_at": null,
"type": "web_fetch_result",
"url": "https://example.com"
} | +| `ToolUseID` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicWebFetchToolResultType](../../models/components/anthropicwebfetchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicwebfetchtoolresulterror.mdx b/docs/models/components/anthropicwebfetchtoolresulterror.mdx index 3923fcf4e..043f09829 100644 --- a/docs/models/components/anthropicwebfetchtoolresulterror.mdx +++ b/docs/models/components/anthropicwebfetchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicWebFetchToolResultError" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.AnthropicWebFetchToolResultErrorErrorCode](../../models/components/anthropicwebfetchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicWebFetchToolResultErrorType](../../models/components/anthropicwebfetchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ErrorCode` | [components.AnthropicWebFetchToolResultErrorErrorCode](../../models/components/anthropicwebfetchtoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `Type` | [components.AnthropicWebFetchToolResultErrorType](../../models/components/anthropicwebfetchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchresult.mdx b/docs/models/components/anthropicwebsearchresult.mdx index c7c292031..0809fe1ea 100644 --- a/docs/models/components/anthropicwebsearchresult.mdx +++ b/docs/models/components/anthropicwebsearchresult.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchResult" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | -| `PageAge` | `*string` | :heavy_check_mark: | N/A | -| `Title` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicWebSearchResultType](../../models/components/anthropicwebsearchresulttype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `EncryptedContent` | `string` | ✅ | N/A | +| `PageAge` | `*string` | ✅ | N/A | +| `Title` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicWebSearchResultType](../../models/components/anthropicwebsearchresulttype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchresultblockparam.mdx b/docs/models/components/anthropicwebsearchresultblockparam.mdx index eb6574209..e47721113 100644 --- a/docs/models/components/anthropicwebsearchresultblockparam.mdx +++ b/docs/models/components/anthropicwebsearchresultblockparam.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchResultBlockParam" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | -| `PageAge` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Title` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicWebSearchResultBlockParamType](../../models/components/anthropicwebsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `EncryptedContent` | `string` | ✅ | N/A | +| `PageAge` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Title` | `string` | ✅ | N/A | +| `Type` | [components.AnthropicWebSearchResultBlockParamType](../../models/components/anthropicwebsearchresultblockparamtype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchtoolresult.mdx b/docs/models/components/anthropicwebsearchtoolresult.mdx index baa262b12..7abc9fe9b 100644 --- a/docs/models/components/anthropicwebsearchtoolresult.mdx +++ b/docs/models/components/anthropicwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "AnthropicWebSearchToolResult" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `Content` | [components.AnthropicWebSearchToolResultContent](../../models/components/anthropicwebsearchtoolresultcontent.mdx) | :heavy_check_mark: | N/A | | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicWebSearchToolResultType](../../models/components/anthropicwebsearchtoolresulttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Caller` | [components.AnthropicCaller](../../models/components/anthropiccaller.mdx) | ✅ | N/A | \{
"type": "direct"
} | +| `Content` | [components.AnthropicWebSearchToolResultContent](../../models/components/anthropicwebsearchtoolresultcontent.mdx) | ✅ | N/A | | +| `ToolUseID` | `string` | ✅ | N/A | | +| `Type` | [components.AnthropicWebSearchToolResultType](../../models/components/anthropicwebsearchtoolresulttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchtoolresulterror.mdx b/docs/models/components/anthropicwebsearchtoolresulterror.mdx index 44eb9f000..6f7751d9a 100644 --- a/docs/models/components/anthropicwebsearchtoolresulterror.mdx +++ b/docs/models/components/anthropicwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "AnthropicWebSearchToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `ErrorCode` | [components.AnthropicWebSearchToolResultErrorErrorCode](../../models/components/anthropicwebsearchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicWebSearchToolResultErrorType](../../models/components/anthropicwebsearchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ErrorCode` | [components.AnthropicWebSearchToolResultErrorErrorCode](../../models/components/anthropicwebsearchtoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `Type` | [components.AnthropicWebSearchToolResultErrorType](../../models/components/anthropicwebsearchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchtooluserlocation.mdx b/docs/models/components/anthropicwebsearchtooluserlocation.mdx index d4d13b471..faddcecbe 100644 --- a/docs/models/components/anthropicwebsearchtooluserlocation.mdx +++ b/docs/models/components/anthropicwebsearchtooluserlocation.mdx @@ -6,8 +6,8 @@ title: "AnthropicWebSearchToolUserLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.AnthropicWebSearchToolUserLocationType](../../models/components/anthropicwebsearchtooluserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.AnthropicWebSearchToolUserLocationType](../../models/components/anthropicwebsearchtooluserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcallitem.mdx b/docs/models/components/applypatchcallitem.mdx index e4cf696eb..294dac6d0 100644 --- a/docs/models/components/applypatchcallitem.mdx +++ b/docs/models/components/applypatchcallitem.mdx @@ -9,8 +9,8 @@ A tool call emitted by the model requesting a V4A patch operation. The client ap | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `Status` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `Type` | [components.ApplyPatchCallItemType](../../models/components/applypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | ✅ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `Status` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | +| `Type` | [components.ApplyPatchCallItemType](../../models/components/applypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx b/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx index 6d90864ad..3f410cdab 100644 --- a/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx +++ b/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx @@ -9,8 +9,8 @@ Incremental chunk of `operation.diff` for an `apply_patch_call`. Matches OpenAI' | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../../models/components/applypatchcalloperationdiffdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../../models/components/applypatchcalloperationdiffdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloperationdiffdoneevent.mdx b/docs/models/components/applypatchcalloperationdiffdoneevent.mdx index eded2af51..5fc4339fd 100644 --- a/docs/models/components/applypatchcalloperationdiffdoneevent.mdx +++ b/docs/models/components/applypatchcalloperationdiffdoneevent.mdx @@ -9,8 +9,8 @@ Emitted when `operation.diff` streaming completes for an `apply_patch_call`. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Diff` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCallOperationDiffDoneEventType](../../models/components/applypatchcalloperationdiffdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Diff` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ApplyPatchCallOperationDiffDoneEventType](../../models/components/applypatchcalloperationdiffdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloutputitem.mdx b/docs/models/components/applypatchcalloutputitem.mdx index e52266b81..26912170c 100644 --- a/docs/models/components/applypatchcalloutputitem.mdx +++ b/docs/models/components/applypatchcalloutputitem.mdx @@ -9,8 +9,8 @@ The client's echo of an `apply_patch_call` after applying the patch. `output` is | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Output` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Status` | [components.ApplyPatchCallOutputItemStatus](../../models/components/applypatchcalloutputitemstatus.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCallOutputItemType](../../models/components/applypatchcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Output` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Status` | [components.ApplyPatchCallOutputItemStatus](../../models/components/applypatchcalloutputitemstatus.mdx) | ✅ | N/A | +| `Type` | [components.ApplyPatchCallOutputItemType](../../models/components/applypatchcalloutputitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcreatefileoperation.mdx b/docs/models/components/applypatchcreatefileoperation.mdx index 031da0c12..b14181550 100644 --- a/docs/models/components/applypatchcreatefileoperation.mdx +++ b/docs/models/components/applypatchcreatefileoperation.mdx @@ -9,6 +9,6 @@ The `create_file` variant of an `apply_patch_call.operation`. Carries a V4A diff | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Diff` | `string` | :heavy_check_mark: | N/A | -| `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCreateFileOperationType](../../models/components/applypatchcreatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Diff` | `string` | ✅ | N/A | +| `Path` | `string` | ✅ | N/A | +| `Type` | [components.ApplyPatchCreateFileOperationType](../../models/components/applypatchcreatefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchdeletefileoperation.mdx b/docs/models/components/applypatchdeletefileoperation.mdx index 961833216..c6fd9c0a7 100644 --- a/docs/models/components/applypatchdeletefileoperation.mdx +++ b/docs/models/components/applypatchdeletefileoperation.mdx @@ -9,5 +9,5 @@ The `delete_file` variant of an `apply_patch_call.operation`. Identifies the fil | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchDeleteFileOperationType](../../models/components/applypatchdeletefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Path` | `string` | ✅ | N/A | +| `Type` | [components.ApplyPatchDeleteFileOperationType](../../models/components/applypatchdeletefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchservertool.mdx b/docs/models/components/applypatchservertool.mdx index 7536b291a..0cccaaf1d 100644 --- a/docs/models/components/applypatchservertool.mdx +++ b/docs/models/components/applypatchservertool.mdx @@ -9,4 +9,4 @@ Apply patch tool configuration | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Type` | [components.ApplyPatchServerToolType](../../models/components/applypatchservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ApplyPatchServerToolType](../../models/components/applypatchservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchservertoolconfig.mdx b/docs/models/components/applypatchservertoolconfig.mdx index 9f223f7ff..823ea3ffe 100644 --- a/docs/models/components/applypatchservertoolconfig.mdx +++ b/docs/models/components/applypatchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:apply_patch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.ApplyPatchEngineEnum](../../models/components/applypatchengineenum.mdx) | :heavy_minus_sign: | Which apply_patch engine to use. "auto" (default) uses native passthrough when the endpoint advertises native apply_patch support, otherwise falls back to OpenRouter's HITL validator. "native" forces native passthrough — when the endpoint does not support native, the request falls back to HITL. "openrouter" always runs the HITL validator. Native passthrough streams the diff incrementally via `apply_patch_call_operation_diff.delta` events; HITL buffers the diff for atomic delivery as a single delta. | auto | \ No newline at end of file +| `Engine` | [*components.ApplyPatchEngineEnum](../../models/components/applypatchengineenum.mdx) | ➖ | Which apply_patch engine to use. "auto" (default) uses native passthrough when the endpoint advertises native apply_patch support, otherwise falls back to OpenRouter's HITL validator. "native" forces native passthrough — when the endpoint does not support native, the request falls back to HITL. "openrouter" always runs the HITL validator. Native passthrough streams the diff incrementally via `apply_patch_call_operation_diff.delta` events; HITL buffers the diff for atomic delivery as a single delta. | auto | \ No newline at end of file diff --git a/docs/models/components/applypatchservertoolopenrouter.mdx b/docs/models/components/applypatchservertoolopenrouter.mdx index db392acd4..32ebb50a9 100644 --- a/docs/models/components/applypatchservertoolopenrouter.mdx +++ b/docs/models/components/applypatchservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: validates V4A diff patches for file operations | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ApplyPatchServerToolConfig](../../models/components/applypatchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | -| `Type` | [components.ApplyPatchServerToolOpenRouterType](../../models/components/applypatchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.ApplyPatchServerToolConfig](../../models/components/applypatchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | +| `Type` | [components.ApplyPatchServerToolOpenRouterType](../../models/components/applypatchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/applypatchupdatefileoperation.mdx b/docs/models/components/applypatchupdatefileoperation.mdx index 33ff6f7bb..726fa8292 100644 --- a/docs/models/components/applypatchupdatefileoperation.mdx +++ b/docs/models/components/applypatchupdatefileoperation.mdx @@ -9,6 +9,6 @@ The `update_file` variant of an `apply_patch_call.operation`. Carries a V4A diff | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Diff` | `string` | :heavy_check_mark: | N/A | -| `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchUpdateFileOperationType](../../models/components/applypatchupdatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Diff` | `string` | ✅ | N/A | +| `Path` | `string` | ✅ | N/A | +| `Type` | [components.ApplyPatchUpdateFileOperationType](../../models/components/applypatchupdatefileoperationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/apprankingsitem.mdx b/docs/models/components/apprankingsitem.mdx index 4e9d6619a..fb3641271 100644 --- a/docs/models/components/apprankingsitem.mdx +++ b/docs/models/components/apprankingsitem.mdx @@ -6,8 +6,8 @@ title: "AppRankingsItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AppID` | `int64` | :heavy_check_mark: | Stable numeric identifier of the app on OpenRouter. | 12345 | -| `AppName` | `string` | :heavy_check_mark: | Public display name of the app. | Cline | -| `Rank` | `int64` | :heavy_check_mark: | 1-based position of the app within this response, per the requested `sort`. | 1 | -| `TotalRequests` | `int64` | :heavy_check_mark: | Number of requests attributed to the app inside the date window. | 4321 | -| `TotalTokens` | `string` | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` attributed to the app inside the date window, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file +| `AppID` | `int64` | ✅ | Stable numeric identifier of the app on OpenRouter. | 12345 | +| `AppName` | `string` | ✅ | Public display name of the app. | Cline | +| `Rank` | `int64` | ✅ | 1-based position of the app within this response, per the requested `sort`. | 1 | +| `TotalRequests` | `int64` | ✅ | Number of requests attributed to the app inside the date window. | 4321 | +| `TotalTokens` | `string` | ✅ | Sum of `prompt_tokens + completion_tokens` attributed to the app inside the date window, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/docs/models/components/apprankingsresponse.mdx b/docs/models/components/apprankingsresponse.mdx index bb0c7e9e9..3737c4dc2 100644 --- a/docs/models/components/apprankingsresponse.mdx +++ b/docs/models/components/apprankingsresponse.mdx @@ -6,5 +6,5 @@ title: "AppRankingsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [][components.AppRankingsItem](../../models/components/apprankingsitem.mdx) | :heavy_check_mark: | Apps ranked per the requested `sort`, re-numbered 1..N after category filtering. `popular` sorts by `total_tokens` descending; `trending` sorts by absolute excess token growth descending and may return fewer than `limit` rows when few apps are growing. | | -| `Meta` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `Data` | [][components.AppRankingsItem](../../models/components/apprankingsitem.mdx) | ✅ | Apps ranked per the requested `sort`, re-numbered 1..N after category filtering. `popular` sorts by `total_tokens` descending; `trending` sorts by absolute excess token growth descending and may return fewer than `limit` rows when few apps are growing. | | +| `Meta` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | ✅ | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/components/architecture.mdx b/docs/models/components/architecture.mdx index ced20cd9f..2346745ca 100644 --- a/docs/models/components/architecture.mdx +++ b/docs/models/components/architecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | :heavy_check_mark: | Supported input modalities | | -| `InstructType` | [*components.InstructType](../../models/components/instructtype.mdx) | :heavy_check_mark: | Instruction format type | chatml | -| `Modality` | `*string` | :heavy_check_mark: | Primary modality of the model | text | -| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | :heavy_check_mark: | Supported output modalities | | -| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file +| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | ✅ | Supported input modalities | | +| `InstructType` | [*components.InstructType](../../models/components/instructtype.mdx) | ✅ | Instruction format type | chatml | +| `Modality` | `*string` | ✅ | Primary modality of the model | text | +| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | ✅ | Supported output modalities | | +| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | ✅ | N/A | GPT | \ No newline at end of file diff --git a/docs/models/components/audiourl.mdx b/docs/models/components/audiourl.mdx index a520320b1..110aeeb30 100644 --- a/docs/models/components/audiourl.mdx +++ b/docs/models/components/audiourl.mdx @@ -6,4 +6,4 @@ title: "AudioURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/autobetarouterplugin.mdx b/docs/models/components/autobetarouterplugin.mdx index 1ada8c6c3..5e082dee5 100644 --- a/docs/models/components/autobetarouterplugin.mdx +++ b/docs/models/components/autobetarouterplugin.mdx @@ -6,9 +6,9 @@ title: "AutoBetaRouterPlugin" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | []`string` | :heavy_minus_sign: | List of model patterns to filter which models the auto-beta-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | -| ~~`CostQualityTradeoff`~~ | `*int64` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-beta-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | -| `CostTier` | [*components.AutoBetaRouterPluginCostTier](../../models/components/autobetarouterplugincosttier.mdx) | :heavy_minus_sign: | Named cost/quality setting. For auto-beta-router, tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | -| `ExcludedModels` | []`string` | :heavy_minus_sign: | List of model patterns to exclude from auto-beta-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | -| `ID` | [components.AutoBetaRouterPluginID](../../models/components/autobetarouterpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `AllowedModels` | []`string` | ➖ | List of model patterns to filter which models the auto-beta-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | +| ~~`CostQualityTradeoff`~~ | `*int64` | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-beta-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | +| `CostTier` | [*components.AutoBetaRouterPluginCostTier](../../models/components/autobetarouterplugincosttier.mdx) | ➖ | Named cost/quality setting. For auto-beta-router, tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | +| `Enabled` | `*bool` | ➖ | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | +| `ExcludedModels` | []`string` | ➖ | List of model patterns to exclude from auto-beta-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | +| `ID` | [components.AutoBetaRouterPluginID](../../models/components/autobetarouterpluginid.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/autorouterplugin.mdx b/docs/models/components/autorouterplugin.mdx index b93045ba8..c61ee00f4 100644 --- a/docs/models/components/autorouterplugin.mdx +++ b/docs/models/components/autorouterplugin.mdx @@ -6,10 +6,10 @@ title: "AutoRouterPlugin" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | []`string` | :heavy_minus_sign: | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | -| ~~`CostQualityTradeoff`~~ | `*int64` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | -| `CostTier` | [*components.AutoRouterPluginCostTier](../../models/components/autorouterplugincosttier.mdx) | :heavy_minus_sign: | Named cost/quality setting. Tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `ExcludedModels` | []`string` | :heavy_minus_sign: | List of model patterns to exclude from auto-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | -| `ID` | [components.AutoRouterPluginID](../../models/components/autorouterpluginid.mdx) | :heavy_check_mark: | N/A | | -| `PinModel` | `*bool` | :heavy_minus_sign: | When true, reuses the model from the most recent assistant message's `model` attribute for subsequent turns. Defaults to false. | false | \ No newline at end of file +| `AllowedModels` | []`string` | ➖ | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | +| ~~`CostQualityTradeoff`~~ | `*int64` | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | +| `CostTier` | [*components.AutoRouterPluginCostTier](../../models/components/autorouterplugincosttier.mdx) | ➖ | Named cost/quality setting. Tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | +| `Enabled` | `*bool` | ➖ | Set to false to disable the auto-router plugin for this request. Defaults to true. | | +| `ExcludedModels` | []`string` | ➖ | List of model patterns to exclude from auto-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | +| `ID` | [components.AutoRouterPluginID](../../models/components/autorouterpluginid.mdx) | ✅ | N/A | | +| `PinModel` | `*bool` | ➖ | When true, reuses the model from the most recent assistant message's `model` attribute for subsequent turns. Defaults to false. | false | \ No newline at end of file diff --git a/docs/models/components/badgatewayresponseerrordata.mdx b/docs/models/components/badgatewayresponseerrordata.mdx index ff8975400..bba1208e9 100644 --- a/docs/models/components/badgatewayresponseerrordata.mdx +++ b/docs/models/components/badgatewayresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for BadGatewayResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/badrequestresponseerrordata.mdx b/docs/models/components/badrequestresponseerrordata.mdx index e9555763c..ea1b654d8 100644 --- a/docs/models/components/badrequestresponseerrordata.mdx +++ b/docs/models/components/badrequestresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for BadRequestResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/baseinputsmessage.mdx b/docs/models/components/baseinputsmessage.mdx index 66d25c30f..963c3f0c9 100644 --- a/docs/models/components/baseinputsmessage.mdx +++ b/docs/models/components/baseinputsmessage.mdx @@ -6,7 +6,7 @@ title: "BaseInputsMessage" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.BaseInputsContent2](../../models/components/baseinputscontent2.mdx) | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.BaseInputsPhaseUnion](../../models/components/baseinputsphaseunion.mdx)] | :heavy_minus_sign: | N/A | -| `Role` | [components.BaseInputsRoleUnion](../../models/components/baseinputsroleunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [*components.BaseInputsType](../../models/components/baseinputstype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Content` | [components.BaseInputsContent2](../../models/components/baseinputscontent2.mdx) | ✅ | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.BaseInputsPhaseUnion](../../models/components/baseinputsphaseunion.mdx)] | ➖ | N/A | +| `Role` | [components.BaseInputsRoleUnion](../../models/components/baseinputsroleunion.mdx) | ✅ | N/A | +| `Type` | [*components.BaseInputsType](../../models/components/baseinputstype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/basereasoningconfig.mdx b/docs/models/components/basereasoningconfig.mdx index 7c6464ad0..de3b22e7f 100644 --- a/docs/models/components/basereasoningconfig.mdx +++ b/docs/models/components/basereasoningconfig.mdx @@ -6,7 +6,7 @@ title: "BaseReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext.mdx)] | :heavy_minus_sign: | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | -| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | :heavy_minus_sign: | N/A | medium | -| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode.mdx)] | :heavy_minus_sign: | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | -| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | :heavy_minus_sign: | N/A | auto | \ No newline at end of file +| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext.mdx)] | ➖ | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | +| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | ➖ | N/A | medium | +| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode.mdx)] | ➖ | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | +| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | ➖ | N/A | auto | \ No newline at end of file diff --git a/docs/models/components/bashservertool.mdx b/docs/models/components/bashservertool.mdx index 40ea034b2..4ae6349ee 100644 --- a/docs/models/components/bashservertool.mdx +++ b/docs/models/components/bashservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: runs shell commands server-side in a sandboxed | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `Parameters` | [*components.BashServerToolConfig](../../models/components/bashservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | -| `Type` | [components.BashServerToolType](../../models/components/bashservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.BashServerToolConfig](../../models/components/bashservertoolconfig.mdx) | ➖ | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | +| `Type` | [components.BashServerToolType](../../models/components/bashservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/bashservertoolconfig.mdx b/docs/models/components/bashservertoolconfig.mdx index 5ae573bc7..6115d30d5 100644 --- a/docs/models/components/bashservertoolconfig.mdx +++ b/docs/models/components/bashservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:bash server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.BashServerToolEngine](../../models/components/bashservertoolengine.mdx) | :heavy_minus_sign: | Which bash engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) and "native" use native passthrough, returning the tool call to your application to run client-side; OpenRouter does not execute the commands. | auto | -| `Environment` | [*components.BashServerToolEnvironment](../../models/components/bashservertoolenvironment.mdx) | :heavy_minus_sign: | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file +| `Engine` | [*components.BashServerToolEngine](../../models/components/bashservertoolengine.mdx) | ➖ | Which bash engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) and "native" use native passthrough, returning the tool call to your application to run client-side; OpenRouter does not execute the commands. | auto | +| `Environment` | [*components.BashServerToolEnvironment](../../models/components/bashservertoolenvironment.mdx) | ➖ | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file diff --git a/docs/models/components/batchdeletedobject.mdx b/docs/models/components/batchdeletedobject.mdx index 6f7e81ab3..c953e817d 100644 --- a/docs/models/components/batchdeletedobject.mdx +++ b/docs/models/components/batchdeletedobject.mdx @@ -9,6 +9,6 @@ Confirms a terminal batch was removed from the API and its OpenRouter-held artif | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Deletion` | [components.BatchDeletionTargets](../../models/components/batchdeletiontargets.mdx) | :heavy_check_mark: | OpenRouter cleanup and, when a provider was assigned, the upstream batch deletion outcome. | \{
"openrouter": "deleted",
"upstream": \{
"provider": "Anthropic",
"status": "deleted"
}
} | -| `ID` | `string` | :heavy_check_mark: | N/A | batch_abc123 | -| `Object` | [components.BatchDeletedObjectObject](../../models/components/batchdeletedobjectobject.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Deletion` | [components.BatchDeletionTargets](../../models/components/batchdeletiontargets.mdx) | ✅ | OpenRouter cleanup and, when a provider was assigned, the upstream batch deletion outcome. | \{
"openrouter": "deleted",
"upstream": \{
"provider": "Anthropic",
"status": "deleted"
}
} | +| `ID` | `string` | ✅ | N/A | batch_abc123 | +| `Object` | [components.BatchDeletedObjectObject](../../models/components/batchdeletedobjectobject.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/batchdeletiontargets.mdx b/docs/models/components/batchdeletiontargets.mdx index 99916516b..3193a3e25 100644 --- a/docs/models/components/batchdeletiontargets.mdx +++ b/docs/models/components/batchdeletiontargets.mdx @@ -9,5 +9,5 @@ OpenRouter cleanup and, when a provider was assigned, the upstream batch deletio | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `Openrouter` | [components.Openrouter](../../models/components/openrouter.mdx) | :heavy_check_mark: | OpenRouter-held request and result artifacts were purged. | -| `Upstream` | [*components.Upstream](../../models/components/upstream.mdx) | :heavy_minus_sign: | The upstream batch deletion outcome; omitted when no provider was assigned. | \ No newline at end of file +| `Openrouter` | [components.Openrouter](../../models/components/openrouter.mdx) | ✅ | OpenRouter-held request and result artifacts were purged. | +| `Upstream` | [*components.Upstream](../../models/components/upstream.mdx) | ➖ | The upstream batch deletion outcome; omitted when no provider was assigned. | \ No newline at end of file diff --git a/docs/models/components/batcherrorresponseerror.mdx b/docs/models/components/batcherrorresponseerror.mdx index f799f19f5..3f1dcc54a 100644 --- a/docs/models/components/batcherrorresponseerror.mdx +++ b/docs/models/components/batcherrorresponseerror.mdx @@ -6,5 +6,5 @@ title: "BatchErrorResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchlistitem.mdx b/docs/models/components/batchlistitem.mdx index df613e1bc..df01b710b 100644 --- a/docs/models/components/batchlistitem.mdx +++ b/docs/models/components/batchlistitem.mdx @@ -9,15 +9,15 @@ Metadata-only batch object. `results` is always `null` in list responses. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `CompletionWindow` | [components.BatchListItemCompletionWindow](../../models/components/batchlistitemcompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | -| `Endpoint` | `string` | :heavy_check_mark: | N/A | -| `Error` | [*components.BatchListItemError](../../models/components/batchlistitemerror.mdx) | :heavy_check_mark: | N/A | -| `FinalizedAt` | `*int64` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Object` | [components.BatchListItemObject](../../models/components/batchlistitemobject.mdx) | :heavy_check_mark: | N/A | -| `RequestCounts` | [components.BatchListItemRequestCounts](../../models/components/batchlistitemrequestcounts.mdx) | :heavy_check_mark: | N/A | -| `Results` | `any` | :heavy_check_mark: | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | -| `Status` | [components.BatchListItemStatus](../../models/components/batchlistitemstatus.mdx) | :heavy_check_mark: | N/A | -| `Usage` | [*components.BatchListItemUsage](../../models/components/batchlistitemusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CompletionWindow` | [components.BatchListItemCompletionWindow](../../models/components/batchlistitemcompletionwindow.mdx) | ✅ | N/A | +| `CreatedAt` | `int64` | ✅ | N/A | +| `Endpoint` | `string` | ✅ | N/A | +| `Error` | [*components.BatchListItemError](../../models/components/batchlistitemerror.mdx) | ✅ | N/A | +| `FinalizedAt` | `*int64` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | +| `Object` | [components.BatchListItemObject](../../models/components/batchlistitemobject.mdx) | ✅ | N/A | +| `RequestCounts` | [components.BatchListItemRequestCounts](../../models/components/batchlistitemrequestcounts.mdx) | ✅ | N/A | +| `Results` | `any` | ✅ | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | +| `Status` | [components.BatchListItemStatus](../../models/components/batchlistitemstatus.mdx) | ✅ | N/A | +| `Usage` | [*components.BatchListItemUsage](../../models/components/batchlistitemusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchlistitemcompletiontokensdetails.mdx b/docs/models/components/batchlistitemcompletiontokensdetails.mdx index 7c457ac86..aba8e00d4 100644 --- a/docs/models/components/batchlistitemcompletiontokensdetails.mdx +++ b/docs/models/components/batchlistitemcompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchListItemCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/batchlistitemerror.mdx b/docs/models/components/batchlistitemerror.mdx index fc3d3b73b..2cd90488a 100644 --- a/docs/models/components/batchlistitemerror.mdx +++ b/docs/models/components/batchlistitemerror.mdx @@ -6,4 +6,4 @@ title: "BatchListItemError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Message` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchlistitemprompttokensdetails.mdx b/docs/models/components/batchlistitemprompttokensdetails.mdx index 297e26e78..910bbc8b9 100644 --- a/docs/models/components/batchlistitemprompttokensdetails.mdx +++ b/docs/models/components/batchlistitemprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/batchlistitemrequestcounts.mdx b/docs/models/components/batchlistitemrequestcounts.mdx index cb9c93774..056e7857b 100644 --- a/docs/models/components/batchlistitemrequestcounts.mdx +++ b/docs/models/components/batchlistitemrequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchListItemRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Completed` | `int64` | :heavy_check_mark: | N/A | -| `Failed` | `int64` | :heavy_check_mark: | N/A | -| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Completed` | `int64` | ✅ | N/A | +| `Failed` | `int64` | ✅ | N/A | +| `Total` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchlistitemservertooluse.mdx b/docs/models/components/batchlistitemservertooluse.mdx index adfeb45cf..85e11ae93 100644 --- a/docs/models/components/batchlistitemservertooluse.mdx +++ b/docs/models/components/batchlistitemservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/batchlistitemusage.mdx b/docs/models/components/batchlistitemusage.mdx index a969f5482..07b202b9e 100644 --- a/docs/models/components/batchlistitemusage.mdx +++ b/docs/models/components/batchlistitemusage.mdx @@ -6,16 +6,16 @@ title: "BatchListItemUsage" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchListItemCompletionTokensDetails](../../models/components/batchlistitemcompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchListItemPromptTokensDetails](../../models/components/batchlistitemprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchListItemServerToolUse](../../models/components/batchlistitemservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | -| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CompletionTokens` | `int64` | ✅ | The tokens generated | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchListItemCompletionTokensDetails](../../models/components/batchlistitemcompletiontokensdetails.mdx)] | ➖ | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchListItemPromptTokensDetails](../../models/components/batchlistitemprompttokensdetails.mdx)] | ➖ | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchListItemServerToolUse](../../models/components/batchlistitemservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | +| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/batchlistresponse.mdx b/docs/models/components/batchlistresponse.mdx index 3d2b16eae..06b5c9aad 100644 --- a/docs/models/components/batchlistresponse.mdx +++ b/docs/models/components/batchlistresponse.mdx @@ -9,8 +9,8 @@ A newest-first page of metadata-only batch objects. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Data` | [][components.BatchListItem](../../models/components/batchlistitem.mdx) | :heavy_check_mark: | N/A | -| `FirstID` | `*string` | :heavy_check_mark: | N/A | -| `HasMore` | `bool` | :heavy_check_mark: | N/A | -| `LastID` | `*string` | :heavy_check_mark: | N/A | -| `Object` | [components.BatchListResponseObject](../../models/components/batchlistresponseobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.BatchListItem](../../models/components/batchlistitem.mdx) | ✅ | N/A | +| `FirstID` | `*string` | ✅ | N/A | +| `HasMore` | `bool` | ✅ | N/A | +| `LastID` | `*string` | ✅ | N/A | +| `Object` | [components.BatchListResponseObject](../../models/components/batchlistresponseobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobject.mdx b/docs/models/components/batchobject.mdx index 35f896573..be04ddc2e 100644 --- a/docs/models/components/batchobject.mdx +++ b/docs/models/components/batchobject.mdx @@ -6,15 +6,15 @@ title: "BatchObject" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `CompletionWindow` | [components.BatchObjectCompletionWindow](../../models/components/batchobjectcompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | -| `Endpoint` | `string` | :heavy_check_mark: | N/A | -| `Error` | [*components.BatchObjectError](../../models/components/batchobjecterror.mdx) | :heavy_check_mark: | N/A | -| `FinalizedAt` | `*int64` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Object` | [components.BatchObjectObjectBatch](../../models/components/batchobjectobjectbatch.mdx) | :heavy_check_mark: | N/A | -| `RequestCounts` | [components.BatchObjectRequestCounts](../../models/components/batchobjectrequestcounts.mdx) | :heavy_check_mark: | N/A | -| `Results` | [][components.Result](../../models/components/result.mdx) | :heavy_check_mark: | N/A | -| `Status` | [components.BatchObjectStatus](../../models/components/batchobjectstatus.mdx) | :heavy_check_mark: | N/A | -| `Usage` | [*components.BatchObjectUsage](../../models/components/batchobjectusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CompletionWindow` | [components.BatchObjectCompletionWindow](../../models/components/batchobjectcompletionwindow.mdx) | ✅ | N/A | +| `CreatedAt` | `int64` | ✅ | N/A | +| `Endpoint` | `string` | ✅ | N/A | +| `Error` | [*components.BatchObjectError](../../models/components/batchobjecterror.mdx) | ✅ | N/A | +| `FinalizedAt` | `*int64` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | +| `Object` | [components.BatchObjectObjectBatch](../../models/components/batchobjectobjectbatch.mdx) | ✅ | N/A | +| `RequestCounts` | [components.BatchObjectRequestCounts](../../models/components/batchobjectrequestcounts.mdx) | ✅ | N/A | +| `Results` | [][components.Result](../../models/components/result.mdx) | ✅ | N/A | +| `Status` | [components.BatchObjectStatus](../../models/components/batchobjectstatus.mdx) | ✅ | N/A | +| `Usage` | [*components.BatchObjectUsage](../../models/components/batchobjectusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectcompletiontokensdetails.mdx b/docs/models/components/batchobjectcompletiontokensdetails.mdx index 66822602c..d84335cbb 100644 --- a/docs/models/components/batchobjectcompletiontokensdetails.mdx +++ b/docs/models/components/batchobjectcompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchObjectCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/batchobjectdata.mdx b/docs/models/components/batchobjectdata.mdx index 90cebb655..c6600f272 100644 --- a/docs/models/components/batchobjectdata.mdx +++ b/docs/models/components/batchobjectdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Embedding` | [components.Embedding](../../models/components/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `Index` | `*int64` | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `Object` | [components.ObjectEmbedding](../../models/components/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Embedding` | [components.Embedding](../../models/components/embedding.mdx) | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `Index` | `*int64` | ➖ | Index of the embedding in the input list | 0 | +| `Object` | [components.ObjectEmbedding](../../models/components/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/batchobjectdebug.mdx b/docs/models/components/batchobjectdebug.mdx index 86f04615a..9b98cb41c 100644 --- a/docs/models/components/batchobjectdebug.mdx +++ b/docs/models/components/batchobjectdebug.mdx @@ -6,6 +6,6 @@ title: "BatchObjectDebug" | Field | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `EchoUpstreamBody` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Timings` | [*components.BatchObjectTimings](../../models/components/batchobjecttimings.mdx) | :heavy_minus_sign: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `EchoUpstreamBody` | map[string]`any` | ➖ | N/A | +| `Timings` | [*components.BatchObjectTimings](../../models/components/batchobjecttimings.mdx) | ➖ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjecterror.mdx b/docs/models/components/batchobjecterror.mdx index bcb5738ff..8f4531f6e 100644 --- a/docs/models/components/batchobjecterror.mdx +++ b/docs/models/components/batchobjecterror.mdx @@ -6,4 +6,4 @@ title: "BatchObjectError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Message` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectfile.mdx b/docs/models/components/batchobjectfile.mdx index 2f7095eff..98f6c5a0e 100644 --- a/docs/models/components/batchobjectfile.mdx +++ b/docs/models/components/batchobjectfile.mdx @@ -6,6 +6,6 @@ title: "BatchObjectFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Content` | [][components.AnnotationContentUnion](../../models/components/annotationcontentunion.mdx) | :heavy_check_mark: | N/A | -| `Hash` | `string` | :heavy_check_mark: | N/A | -| `Name` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Content` | [][components.AnnotationContentUnion](../../models/components/annotationcontentunion.mdx) | ✅ | N/A | +| `Hash` | `string` | ✅ | N/A | +| `Name` | `*string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectfunction.mdx b/docs/models/components/batchobjectfunction.mdx index c7ac99b41..e9317af29 100644 --- a/docs/models/components/batchobjectfunction.mdx +++ b/docs/models/components/batchobjectfunction.mdx @@ -6,5 +6,5 @@ title: "BatchObjectFunction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectimageurl.mdx b/docs/models/components/batchobjectimageurl.mdx index 0d092d54e..d324437e4 100644 --- a/docs/models/components/batchobjectimageurl.mdx +++ b/docs/models/components/batchobjectimageurl.mdx @@ -6,4 +6,4 @@ title: "BatchObjectImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectprompttokensdetails.mdx b/docs/models/components/batchobjectprompttokensdetails.mdx index 07352f8e8..3e485e754 100644 --- a/docs/models/components/batchobjectprompttokensdetails.mdx +++ b/docs/models/components/batchobjectprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/batchobjectrequestcounts.mdx b/docs/models/components/batchobjectrequestcounts.mdx index 8df8e75df..dbeb6020b 100644 --- a/docs/models/components/batchobjectrequestcounts.mdx +++ b/docs/models/components/batchobjectrequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchObjectRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Completed` | `int64` | :heavy_check_mark: | N/A | -| `Failed` | `int64` | :heavy_check_mark: | N/A | -| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Completed` | `int64` | ✅ | N/A | +| `Failed` | `int64` | ✅ | N/A | +| `Total` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectresponse.mdx b/docs/models/components/batchobjectresponse.mdx index 46a3abb58..706214072 100644 --- a/docs/models/components/batchobjectresponse.mdx +++ b/docs/models/components/batchobjectresponse.mdx @@ -6,6 +6,6 @@ title: "BatchObjectResponse" | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Body` | [components.Body](../../models/components/body.mdx) | :heavy_check_mark: | N/A | -| `RequestID` | `*string` | :heavy_check_mark: | N/A | -| `StatusCode` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Body` | [components.Body](../../models/components/body.mdx) | ✅ | N/A | +| `RequestID` | `*string` | ✅ | N/A | +| `StatusCode` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectservertooluse.mdx b/docs/models/components/batchobjectservertooluse.mdx index 71ae22911..4e28249d2 100644 --- a/docs/models/components/batchobjectservertooluse.mdx +++ b/docs/models/components/batchobjectservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/batchobjectservertoolusedetails.mdx b/docs/models/components/batchobjectservertoolusedetails.mdx index 882e48712..11fa39ccc 100644 --- a/docs/models/components/batchobjectservertoolusedetails.mdx +++ b/docs/models/components/batchobjectservertoolusedetails.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/batchobjecttimings.mdx b/docs/models/components/batchobjecttimings.mdx index 2b167dc68..8570766fb 100644 --- a/docs/models/components/batchobjecttimings.mdx +++ b/docs/models/components/batchobjecttimings.mdx @@ -6,6 +6,6 @@ title: "BatchObjectTimings" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `EpochMs` | `int64` | :heavy_check_mark: | N/A | -| `Event` | [components.BatchObjectEvent](../../models/components/batchobjectevent.mdx) | :heavy_check_mark: | N/A | -| `StartMs` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `EpochMs` | `int64` | ✅ | N/A | +| `Event` | [components.BatchObjectEvent](../../models/components/batchobjectevent.mdx) | ✅ | N/A | +| `StartMs` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjecturlcitation.mdx b/docs/models/components/batchobjecturlcitation.mdx index f8472027f..59b4af09c 100644 --- a/docs/models/components/batchobjecturlcitation.mdx +++ b/docs/models/components/batchobjecturlcitation.mdx @@ -6,8 +6,8 @@ title: "BatchObjectURLCitation" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Content` | `*string` | :heavy_minus_sign: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Title` | `string` | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | `*string` | ➖ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Title` | `string` | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchobjectusage.mdx b/docs/models/components/batchobjectusage.mdx index 252e2493d..b4706bf1b 100644 --- a/docs/models/components/batchobjectusage.mdx +++ b/docs/models/components/batchobjectusage.mdx @@ -6,16 +6,16 @@ title: "BatchObjectUsage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchObjectCompletionTokensDetails](../../models/components/batchobjectcompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchObjectPromptTokensDetails](../../models/components/batchobjectprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchObjectServerToolUse](../../models/components/batchobjectservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | -| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CompletionTokens` | `int64` | ✅ | The tokens generated | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchObjectCompletionTokensDetails](../../models/components/batchobjectcompletiontokensdetails.mdx)] | ➖ | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchObjectPromptTokensDetails](../../models/components/batchobjectprompttokensdetails.mdx)] | ➖ | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchObjectServerToolUse](../../models/components/batchobjectservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | +| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx b/docs/models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx index d107c860a..8fb8538c9 100644 --- a/docs/models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx +++ b/docs/models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BatchPaymentRequiredResponseCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponseerror.mdx b/docs/models/components/batchpaymentrequiredresponseerror.mdx index 644a8211a..8b1b3c34e 100644 --- a/docs/models/components/batchpaymentrequiredresponseerror.mdx +++ b/docs/models/components/batchpaymentrequiredresponseerror.mdx @@ -6,5 +6,5 @@ title: "BatchPaymentRequiredResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponseprompttokensdetails.mdx b/docs/models/components/batchpaymentrequiredresponseprompttokensdetails.mdx index ba9b93fc1..9f90395b7 100644 --- a/docs/models/components/batchpaymentrequiredresponseprompttokensdetails.mdx +++ b/docs/models/components/batchpaymentrequiredresponseprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponserequestcounts.mdx b/docs/models/components/batchpaymentrequiredresponserequestcounts.mdx index a00aba618..23a84950a 100644 --- a/docs/models/components/batchpaymentrequiredresponserequestcounts.mdx +++ b/docs/models/components/batchpaymentrequiredresponserequestcounts.mdx @@ -6,6 +6,6 @@ title: "BatchPaymentRequiredResponseRequestCounts" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Completed` | `int64` | :heavy_check_mark: | N/A | -| `Failed` | `int64` | :heavy_check_mark: | N/A | -| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Completed` | `int64` | ✅ | N/A | +| `Failed` | `int64` | ✅ | N/A | +| `Total` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponseservertooluse.mdx b/docs/models/components/batchpaymentrequiredresponseservertooluse.mdx index 7463355f1..0d7075ac6 100644 --- a/docs/models/components/batchpaymentrequiredresponseservertooluse.mdx +++ b/docs/models/components/batchpaymentrequiredresponseservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/batchpaymentrequiredresponseusage.mdx b/docs/models/components/batchpaymentrequiredresponseusage.mdx index 08fa6c498..e73d54c5c 100644 --- a/docs/models/components/batchpaymentrequiredresponseusage.mdx +++ b/docs/models/components/batchpaymentrequiredresponseusage.mdx @@ -6,16 +6,16 @@ title: "BatchPaymentRequiredResponseUsage" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponseCompletionTokensDetails](../../models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponsePromptTokensDetails](../../models/components/batchpaymentrequiredresponseprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponseServerToolUse](../../models/components/batchpaymentrequiredresponseservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | -| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CompletionTokens` | `int64` | ✅ | The tokens generated | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponseCompletionTokensDetails](../../models/components/batchpaymentrequiredresponsecompletiontokensdetails.mdx)] | ➖ | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponsePromptTokensDetails](../../models/components/batchpaymentrequiredresponseprompttokensdetails.mdx)] | ➖ | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BatchPaymentRequiredResponseServerToolUse](../../models/components/batchpaymentrequiredresponseservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | +| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/batchproviderpreferences.mdx b/docs/models/components/batchproviderpreferences.mdx index d9734d0b4..b69a993ed 100644 --- a/docs/models/components/batchproviderpreferences.mdx +++ b/docs/models/components/batchproviderpreferences.mdx @@ -9,5 +9,5 @@ Batch provider routing preferences. Only `provider.only` and `provider.allow_fal | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `Only` | optionalnullable.OptionalNullable[[][components.BatchProviderPreferencesOnly](../../models/components/batchproviderpreferencesonly.mdx)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | \ No newline at end of file +| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `Only` | optionalnullable.OptionalNullable[[][components.BatchProviderPreferencesOnly](../../models/components/batchproviderpreferencesonly.mdx)] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | \ No newline at end of file diff --git a/docs/models/components/batchsubmitbody.mdx b/docs/models/components/batchsubmitbody.mdx index 0753ceb24..1392ef351 100644 --- a/docs/models/components/batchsubmitbody.mdx +++ b/docs/models/components/batchsubmitbody.mdx @@ -9,8 +9,8 @@ Batch submit request body. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `CompletionWindow` | [*components.BatchSubmitBodyCompletionWindow](../../models/components/batchsubmitbodycompletionwindow.mdx) | :heavy_minus_sign: | N/A | | -| `Endpoint` | [components.Endpoint](../../models/components/endpoint.mdx) | :heavy_check_mark: | N/A | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Provider` | optionalnullable.OptionalNullable[[components.BatchProviderPreferences](../../models/components/batchproviderpreferences.mdx)] | :heavy_minus_sign: | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | -| `Requests` | [][components.Request](../../models/components/request.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CompletionWindow` | [*components.BatchSubmitBodyCompletionWindow](../../models/components/batchsubmitbodycompletionwindow.mdx) | ➖ | N/A | | +| `Endpoint` | [components.Endpoint](../../models/components/endpoint.mdx) | ✅ | N/A | | +| `Model` | `string` | ✅ | N/A | | +| `Provider` | optionalnullable.OptionalNullable[[components.BatchProviderPreferences](../../models/components/batchproviderpreferences.mdx)] | ➖ | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | +| `Requests` | [][components.Request](../../models/components/request.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/bodychatcompletion.mdx b/docs/models/components/bodychatcompletion.mdx index 971a28926..20a905143 100644 --- a/docs/models/components/bodychatcompletion.mdx +++ b/docs/models/components/bodychatcompletion.mdx @@ -6,15 +6,15 @@ title: "BodyChatCompletion" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Alignment` | [*components.Alignment](../../models/components/alignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | -| `Choices` | [][components.Choice](../../models/components/choice.mdx) | :heavy_check_mark: | N/A | | -| `Created` | `int64` | :heavy_check_mark: | N/A | | -| `Debug` | [*components.BatchObjectDebug](../../models/components/batchobjectdebug.mdx) | :heavy_minus_sign: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Object` | [components.BodyObjectChatCompletion](../../models/components/bodyobjectchatcompletion.mdx) | :heavy_check_mark: | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `Provider` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `SystemFingerprint` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Usage` | [*components.BodyUsage1](../../models/components/bodyusage1.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Alignment` | [*components.Alignment](../../models/components/alignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | +| `Choices` | [][components.Choice](../../models/components/choice.mdx) | ✅ | N/A | | +| `Created` | `int64` | ✅ | N/A | | +| `Debug` | [*components.BatchObjectDebug](../../models/components/batchobjectdebug.mdx) | ➖ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Model` | `string` | ✅ | N/A | | +| `Object` | [components.BodyObjectChatCompletion](../../models/components/bodyobjectchatcompletion.mdx) | ✅ | N/A | | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `Provider` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `SystemFingerprint` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Usage` | [*components.BodyUsage1](../../models/components/bodyusage1.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/bodycompletiontokensdetails.mdx b/docs/models/components/bodycompletiontokensdetails.mdx index d7da7be75..c8986b7e5 100644 --- a/docs/models/components/bodycompletiontokensdetails.mdx +++ b/docs/models/components/bodycompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "BodyCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/bodylist.mdx b/docs/models/components/bodylist.mdx index 4f97d6766..cec25daff 100644 --- a/docs/models/components/bodylist.mdx +++ b/docs/models/components/bodylist.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Data` | [][components.BatchObjectData](../../models/components/batchobjectdata.mdx) | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `ID` | `*string` | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | -| `Model` | `string` | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | -| `Object` | [components.BodyObjectList](../../models/components/bodyobjectlist.mdx) | :heavy_check_mark: | N/A | | -| `Usage` | [*components.BodyUsage3](../../models/components/bodyusage3.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `Data` | [][components.BatchObjectData](../../models/components/batchobjectdata.mdx) | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `ID` | `*string` | ➖ | Unique identifier for the embeddings response | embd-1234567890 | +| `Model` | `string` | ✅ | The model used for embeddings | openai/text-embedding-3-small | +| `Object` | [components.BodyObjectList](../../models/components/bodyobjectlist.mdx) | ✅ | N/A | | +| `Usage` | [*components.BodyUsage3](../../models/components/bodyusage3.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/models/components/bodymessage.mdx b/docs/models/components/bodymessage.mdx index d3294f68f..a59b91a48 100644 --- a/docs/models/components/bodymessage.mdx +++ b/docs/models/components/bodymessage.mdx @@ -6,14 +6,14 @@ title: "BodyMessage" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Container` | [*components.AnthropicContainer](../../models/components/anthropiccontainer.mdx) | :heavy_check_mark: | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | -| `Content` | [][components.ORAnthropicContentBlock](../../models/components/oranthropiccontentblock.mdx) | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `InputTransformations` | optionalnullable.OptionalNullable[[][components.AnthropicInputTransformation](../../models/components/anthropicinputtransformation.mdx)] | :heavy_minus_sign: | N/A | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Role` | [components.BatchObjectRole](../../models/components/batchobjectrole.mdx) | :heavy_check_mark: | N/A | | -| `StopDetails` | [*components.AnthropicRefusalStopDetails](../../models/components/anthropicrefusalstopdetails.mdx) | :heavy_check_mark: | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | -| `StopReason` | [*components.ORAnthropicStopReason](../../models/components/oranthropicstopreason.mdx) | :heavy_check_mark: | N/A | end_turn | -| `StopSequence` | `*string` | :heavy_check_mark: | N/A | | -| `Type` | [components.BatchObjectTypeMessage](../../models/components/batchobjecttypemessage.mdx) | :heavy_check_mark: | N/A | | -| `Usage` | [components.BodyUsage2](../../models/components/bodyusage2.mdx) | :heavy_check_mark: | N/A | \{
"cache_creation": null,
"cache_creation_input_tokens": null,
"cache_read_input_tokens": null,
"inference_geo": null,
"input_tokens": 100,
"output_tokens": 50,
"output_tokens_details": null,
"server_tool_use": null,
"service_tier": "standard"
} | \ No newline at end of file +| `Container` | [*components.AnthropicContainer](../../models/components/anthropiccontainer.mdx) | ✅ | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | +| `Content` | [][components.ORAnthropicContentBlock](../../models/components/oranthropiccontentblock.mdx) | ✅ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `InputTransformations` | optionalnullable.OptionalNullable[[][components.AnthropicInputTransformation](../../models/components/anthropicinputtransformation.mdx)] | ➖ | N/A | | +| `Model` | `string` | ✅ | N/A | | +| `Role` | [components.BatchObjectRole](../../models/components/batchobjectrole.mdx) | ✅ | N/A | | +| `StopDetails` | [*components.AnthropicRefusalStopDetails](../../models/components/anthropicrefusalstopdetails.mdx) | ✅ | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | +| `StopReason` | [*components.ORAnthropicStopReason](../../models/components/oranthropicstopreason.mdx) | ✅ | N/A | end_turn | +| `StopSequence` | `*string` | ✅ | N/A | | +| `Type` | [components.BatchObjectTypeMessage](../../models/components/batchobjecttypemessage.mdx) | ✅ | N/A | | +| `Usage` | [components.BodyUsage2](../../models/components/bodyusage2.mdx) | ✅ | N/A | \{
"cache_creation": null,
"cache_creation_input_tokens": null,
"cache_read_input_tokens": null,
"inference_geo": null,
"input_tokens": 100,
"output_tokens": 50,
"output_tokens_details": null,
"server_tool_use": null,
"service_tier": "standard"
} | \ No newline at end of file diff --git a/docs/models/components/bodyprompttokensdetails1.mdx b/docs/models/components/bodyprompttokensdetails1.mdx index f83c47624..63b8f5031 100644 --- a/docs/models/components/bodyprompttokensdetails1.mdx +++ b/docs/models/components/bodyprompttokensdetails1.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/bodyprompttokensdetails2.mdx b/docs/models/components/bodyprompttokensdetails2.mdx index 8364544db..645d373d9 100644 --- a/docs/models/components/bodyprompttokensdetails2.mdx +++ b/docs/models/components/bodyprompttokensdetails2.mdx @@ -9,8 +9,8 @@ Per-modality token breakdown. Only present when the input contains 2+ modalities | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `AudioTokens` | `*int64` | :heavy_minus_sign: | Number of audio tokens in the input | | -| `FileTokens` | `*int64` | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `ImageTokens` | `*int64` | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `TextTokens` | `*int64` | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `VideoTokens` | `*int64` | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file +| `AudioTokens` | `*int64` | ➖ | Number of audio tokens in the input | | +| `FileTokens` | `*int64` | ➖ | Number of file/document tokens in the input | | +| `ImageTokens` | `*int64` | ➖ | Number of image tokens in the input | 258 | +| `TextTokens` | `*int64` | ➖ | Number of text tokens in the input | 8 | +| `VideoTokens` | `*int64` | ➖ | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/models/components/bodyservertooluse.mdx b/docs/models/components/bodyservertooluse.mdx index 81a3cc565..0c0bd4b7f 100644 --- a/docs/models/components/bodyservertooluse.mdx +++ b/docs/models/components/bodyservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/bodyusage1.mdx b/docs/models/components/bodyusage1.mdx index 865df2c49..81fa18224 100644 --- a/docs/models/components/bodyusage1.mdx +++ b/docs/models/components/bodyusage1.mdx @@ -6,10 +6,10 @@ title: "BodyUsage1" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BodyCompletionTokensDetails](../../models/components/bodycompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | -| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BodyPromptTokensDetails1](../../models/components/bodyprompttokensdetails1.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BodyServerToolUse](../../models/components/bodyservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | -| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.BatchObjectServerToolUseDetails](../../models/components/batchobjectservertoolusedetails.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | -| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | \ No newline at end of file +| `CompletionTokens` | `int64` | ✅ | The tokens generated | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.BodyCompletionTokensDetails](../../models/components/bodycompletiontokensdetails.mdx)] | ➖ | N/A | +| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.BodyPromptTokensDetails1](../../models/components/bodyprompttokensdetails1.mdx)] | ➖ | Breakdown of tokens used in the prompt. | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.BodyServerToolUse](../../models/components/bodyservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | +| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.BatchObjectServerToolUseDetails](../../models/components/batchobjectservertoolusedetails.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | +| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | \ No newline at end of file diff --git a/docs/models/components/bodyusage2.mdx b/docs/models/components/bodyusage2.mdx index b8a163a97..80031359c 100644 --- a/docs/models/components/bodyusage2.mdx +++ b/docs/models/components/bodyusage2.mdx @@ -6,14 +6,14 @@ title: "BodyUsage2" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | [*components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx) | :heavy_check_mark: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CacheCreationInputTokens` | `*int64` | :heavy_check_mark: | N/A | | -| `CacheReadInputTokens` | `*int64` | :heavy_check_mark: | N/A | | -| `InferenceGeo` | `*string` | :heavy_check_mark: | N/A | | -| `InputTokens` | `int64` | :heavy_check_mark: | N/A | | -| `OutputTokens` | `int64` | :heavy_check_mark: | N/A | | -| `OutputTokensDetails` | [*components.AnthropicOutputTokensDetails](../../models/components/anthropicoutputtokensdetails.mdx) | :heavy_check_mark: | N/A | \{
"thinking_tokens": 0
} | -| `ServerToolUse` | [*components.AnthropicServerToolUsage](../../models/components/anthropicservertoolusage.mdx) | :heavy_check_mark: | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | -| `ServiceTier` | [*components.AnthropicServiceTier](../../models/components/anthropicservicetier.mdx) | :heavy_check_mark: | N/A | standard | -| `Iterations` | [][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx) | :heavy_minus_sign: | N/A | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | \ No newline at end of file +| `CacheCreation` | [*components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx) | ✅ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CacheCreationInputTokens` | `*int64` | ✅ | N/A | | +| `CacheReadInputTokens` | `*int64` | ✅ | N/A | | +| `InferenceGeo` | `*string` | ✅ | N/A | | +| `InputTokens` | `int64` | ✅ | N/A | | +| `OutputTokens` | `int64` | ✅ | N/A | | +| `OutputTokensDetails` | [*components.AnthropicOutputTokensDetails](../../models/components/anthropicoutputtokensdetails.mdx) | ✅ | N/A | \{
"thinking_tokens": 0
} | +| `ServerToolUse` | [*components.AnthropicServerToolUsage](../../models/components/anthropicservertoolusage.mdx) | ✅ | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | +| `ServiceTier` | [*components.AnthropicServiceTier](../../models/components/anthropicservicetier.mdx) | ✅ | N/A | standard | +| `Iterations` | [][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx) | ➖ | N/A | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | \ No newline at end of file diff --git a/docs/models/components/bodyusage3.mdx b/docs/models/components/bodyusage3.mdx index 07c87f802..26ad5632a 100644 --- a/docs/models/components/bodyusage3.mdx +++ b/docs/models/components/bodyusage3.mdx @@ -9,9 +9,9 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `PromptTokens` | `int64` | :heavy_check_mark: | Number of tokens in the input | 8 | -| `PromptTokensDetails` | [*components.BodyPromptTokensDetails2](../../models/components/bodyprompttokensdetails2.mdx) | :heavy_minus_sign: | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | -| `TotalTokens` | `int64` | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file +| `Cost` | `*float64` | ➖ | Cost of the request in credits | 0.0001 | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `PromptTokens` | `int64` | ✅ | Number of tokens in the input | 8 | +| `PromptTokensDetails` | [*components.BodyPromptTokensDetails2](../../models/components/bodyprompttokensdetails2.mdx) | ➖ | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | +| `TotalTokens` | `int64` | ✅ | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/models/components/booleancapability.mdx b/docs/models/components/booleancapability.mdx index 3505ed8c7..43e0df119 100644 --- a/docs/models/components/booleancapability.mdx +++ b/docs/models/components/booleancapability.mdx @@ -9,4 +9,4 @@ A supported-or-not flag. Present means the parameter is accepted. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.BooleanCapabilityType](../../models/components/booleancapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.BooleanCapabilityType](../../models/components/booleancapabilitytype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/bulkaddworkspacemembersrequest.mdx b/docs/models/components/bulkaddworkspacemembersrequest.mdx index 095d9bcf8..b31c67d3e 100644 --- a/docs/models/components/bulkaddworkspacemembersrequest.mdx +++ b/docs/models/components/bulkaddworkspacemembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `UserIds` | []`string` | :heavy_check_mark: | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `UserIds` | []`string` | ✅ | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/components/bulkaddworkspacemembersresponse.mdx b/docs/models/components/bulkaddworkspacemembersresponse.mdx index a7b13193c..e198a271b 100644 --- a/docs/models/components/bulkaddworkspacemembersresponse.mdx +++ b/docs/models/components/bulkaddworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "BulkAddWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `AddedCount` | `int64` | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | -| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file +| `AddedCount` | `int64` | ✅ | Number of workspace memberships created or updated | 2 | +| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | ✅ | List of added workspace memberships | | \ No newline at end of file diff --git a/docs/models/components/bulkassignkeysrequest.mdx b/docs/models/components/bulkassignkeysrequest.mdx index 5d58c25e0..66acb2f5e 100644 --- a/docs/models/components/bulkassignkeysrequest.mdx +++ b/docs/models/components/bulkassignkeysrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAssignKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `KeyHashes` | []`string` | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `KeyHashes` | []`string` | ✅ | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/models/components/bulkassignkeysresponse.mdx b/docs/models/components/bulkassignkeysresponse.mdx index 09ba20be2..37c84ffa5 100644 --- a/docs/models/components/bulkassignkeysresponse.mdx +++ b/docs/models/components/bulkassignkeysresponse.mdx @@ -6,4 +6,4 @@ title: "BulkAssignKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `AssignedCount` | `int64` | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file +| `AssignedCount` | `int64` | ✅ | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/docs/models/components/bulkassignmembersrequest.mdx b/docs/models/components/bulkassignmembersrequest.mdx index dcdcf66aa..c9aa0041a 100644 --- a/docs/models/components/bulkassignmembersrequest.mdx +++ b/docs/models/components/bulkassignmembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkAssignMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `MemberUserIds` | []`string` | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `MemberUserIds` | []`string` | ✅ | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/components/bulkassignmembersresponse.mdx b/docs/models/components/bulkassignmembersresponse.mdx index 84706a4af..fa3dcd9ab 100644 --- a/docs/models/components/bulkassignmembersresponse.mdx +++ b/docs/models/components/bulkassignmembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkAssignMembersResponse" | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `AssignedCount` | `int64` | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file +| `AssignedCount` | `int64` | ✅ | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/docs/models/components/bulkremoveworkspacemembersrequest.mdx b/docs/models/components/bulkremoveworkspacemembersrequest.mdx index 1752a0fe3..b3ef57abc 100644 --- a/docs/models/components/bulkremoveworkspacemembersrequest.mdx +++ b/docs/models/components/bulkremoveworkspacemembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `UserIds` | []`string` | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `UserIds` | []`string` | ✅ | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/components/bulkremoveworkspacemembersresponse.mdx b/docs/models/components/bulkremoveworkspacemembersresponse.mdx index 216da1c53..1f6b418f3 100644 --- a/docs/models/components/bulkremoveworkspacemembersresponse.mdx +++ b/docs/models/components/bulkremoveworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkRemoveWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `RemovedCount` | `int64` | :heavy_check_mark: | Number of members removed | 2 | \ No newline at end of file +| `RemovedCount` | `int64` | ✅ | Number of members removed | 2 | \ No newline at end of file diff --git a/docs/models/components/bulkunassignkeysrequest.mdx b/docs/models/components/bulkunassignkeysrequest.mdx index 676cdd92b..a78d4eb28 100644 --- a/docs/models/components/bulkunassignkeysrequest.mdx +++ b/docs/models/components/bulkunassignkeysrequest.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `KeyHashes` | []`string` | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `KeyHashes` | []`string` | ✅ | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/models/components/bulkunassignkeysresponse.mdx b/docs/models/components/bulkunassignkeysresponse.mdx index dee892f3e..5035deb2d 100644 --- a/docs/models/components/bulkunassignkeysresponse.mdx +++ b/docs/models/components/bulkunassignkeysresponse.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignKeysResponse" | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `UnassignedCount` | `int64` | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file +| `UnassignedCount` | `int64` | ✅ | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/docs/models/components/bulkunassignmembersrequest.mdx b/docs/models/components/bulkunassignmembersrequest.mdx index 48269d7fc..ebe0f6899 100644 --- a/docs/models/components/bulkunassignmembersrequest.mdx +++ b/docs/models/components/bulkunassignmembersrequest.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `MemberUserIds` | []`string` | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `MemberUserIds` | []`string` | ✅ | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/components/bulkunassignmembersresponse.mdx b/docs/models/components/bulkunassignmembersresponse.mdx index ae3096508..812034694 100644 --- a/docs/models/components/bulkunassignmembersresponse.mdx +++ b/docs/models/components/bulkunassignmembersresponse.mdx @@ -6,4 +6,4 @@ title: "BulkUnassignMembersResponse" | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `UnassignedCount` | `int64` | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file +| `UnassignedCount` | `int64` | ✅ | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/docs/models/components/byokkey.mdx b/docs/models/components/byokkey.mdx index bf1ddc3e2..1b37065b2 100644 --- a/docs/models/components/byokkey.mdx +++ b/docs/models/components/byokkey.mdx @@ -6,19 +6,19 @@ title: "BYOKKey" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedAPIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `AllowedModels` | []`string` | :heavy_check_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `AllowedUserIds` | []`string` | :heavy_check_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | -| `DeclaredRegion` | [*components.BYOKKeyDeclaredRegion](../../models/components/byokkeydeclaredregion.mdx) | :heavy_check_mark: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. | null | -| `DeclaredZdr` | `*bool` | :heavy_check_mark: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. | null | -| `Disabled` | `bool` | :heavy_check_mark: | Whether this credential is currently disabled. | false | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | -| `IsBYOKOnly` | `bool` | :heavy_check_mark: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. | false | -| `IsFallback` | `bool` | :heavy_check_mark: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | -| `IsRequired` | `bool` | :heavy_check_mark: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. | false | -| `Label` | `string` | :heavy_check_mark: | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | -| `Name` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `SortOrder` | `int64` | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | -| `WorkspaceID` | `*string` | :heavy_check_mark: | The workspace this credential is scoped to, or `null` when it is global — usable across every workspace in the account. A `null` value does not mean the default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `AllowedAPIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `AllowedModels` | []`string` | ✅ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `AllowedUserIds` | []`string` | ✅ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | +| `DeclaredRegion` | [*components.BYOKKeyDeclaredRegion](../../models/components/byokkeydeclaredregion.mdx) | ✅ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. | null | +| `DeclaredZdr` | `*bool` | ✅ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. | null | +| `Disabled` | `bool` | ✅ | Whether this credential is currently disabled. | false | +| `ID` | `string` | ✅ | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | +| `IsBYOKOnly` | `bool` | ✅ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. | false | +| `IsFallback` | `bool` | ✅ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | +| `IsRequired` | `bool` | ✅ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. | false | +| `Label` | `string` | ✅ | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | +| `Name` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | +| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `SortOrder` | `int64` | ✅ | Position within the provider — credentials are tried in ascending sort order. | 0 | +| `WorkspaceID` | `*string` | ✅ | The workspace this credential is scoped to, or `null` when it is global — usable across every workspace in the account. A `null` value does not mean the default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/chatassistantimages.mdx b/docs/models/components/chatassistantimages.mdx index fd6c5d754..442401b7a 100644 --- a/docs/models/components/chatassistantimages.mdx +++ b/docs/models/components/chatassistantimages.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImages" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ChatAssistantImagesImageURL](../../models/components/chatassistantimagesimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.ChatAssistantImagesImageURL](../../models/components/chatassistantimagesimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatassistantimagesimageurl.mdx b/docs/models/components/chatassistantimagesimageurl.mdx index 791d7db4b..9a6f057c8 100644 --- a/docs/models/components/chatassistantimagesimageurl.mdx +++ b/docs/models/components/chatassistantimagesimageurl.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImagesImageURL" | Field | Type | Required | Description | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `URL` | `string` | :heavy_check_mark: | URL or base64-encoded data of the generated image | \ No newline at end of file +| `URL` | `string` | ✅ | URL or base64-encoded data of the generated image | \ No newline at end of file diff --git a/docs/models/components/chatassistantmessage.mdx b/docs/models/components/chatassistantmessage.mdx index d41ea38d2..236bfc5c4 100644 --- a/docs/models/components/chatassistantmessage.mdx +++ b/docs/models/components/chatassistantmessage.mdx @@ -9,13 +9,13 @@ Assistant message for requests and responses | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | :heavy_minus_sign: | Audio output data or reference | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | -| `Content` | optionalnullable.OptionalNullable[[components.ChatAssistantMessageContent](../../models/components/chatassistantmessagecontent.mdx)] | :heavy_minus_sign: | Assistant message content | | -| `Images` | [][components.ChatAssistantImages](../../models/components/chatassistantimages.mdx) | :heavy_minus_sign: | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | -| `Model` | `*string` | :heavy_minus_sign: | Model that generated this assistant message | openai/gpt-4o | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for the assistant | | -| `Reasoning` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Reasoning output | | -| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | -| `Refusal` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Refusal message if content was refused | | -| `Role` | [components.ChatAssistantMessageRole](../../models/components/chatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `ToolCalls` | [][components.ChatToolCall](../../models/components/chattoolcall.mdx) | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file +| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | ➖ | Audio output data or reference | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `Content` | optionalnullable.OptionalNullable[[components.ChatAssistantMessageContent](../../models/components/chatassistantmessagecontent.mdx)] | ➖ | Assistant message content | | +| `Images` | [][components.ChatAssistantImages](../../models/components/chatassistantimages.mdx) | ➖ | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | +| `Model` | `*string` | ➖ | Model that generated this assistant message | openai/gpt-4o | +| `Name` | `*string` | ➖ | Optional name for the assistant | | +| `Reasoning` | optionalnullable.OptionalNullable[`string`] | ➖ | Reasoning output | | +| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | +| `Refusal` | optionalnullable.OptionalNullable[`string`] | ➖ | Refusal message if content was refused | | +| `Role` | [components.ChatAssistantMessageRole](../../models/components/chatassistantmessagerole.mdx) | ✅ | N/A | | +| `ToolCalls` | [][components.ChatToolCall](../../models/components/chattoolcall.mdx) | ➖ | Tool calls made by the assistant | | \ No newline at end of file diff --git a/docs/models/components/chataudiooutput.mdx b/docs/models/components/chataudiooutput.mdx index 944273328..c7e45be43 100644 --- a/docs/models/components/chataudiooutput.mdx +++ b/docs/models/components/chataudiooutput.mdx @@ -9,7 +9,7 @@ Audio output data or reference | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Data` | `*string` | :heavy_minus_sign: | Base64 encoded audio data | -| `ExpiresAt` | `*int64` | :heavy_minus_sign: | Audio expiration timestamp | -| `ID` | `*string` | :heavy_minus_sign: | Audio output identifier | -| `Transcript` | `*string` | :heavy_minus_sign: | Audio transcript | \ No newline at end of file +| `Data` | `*string` | ➖ | Base64 encoded audio data | +| `ExpiresAt` | `*int64` | ➖ | Audio expiration timestamp | +| `ID` | `*string` | ➖ | Audio output identifier | +| `Transcript` | `*string` | ➖ | Audio transcript | \ No newline at end of file diff --git a/docs/models/components/chatchoice.mdx b/docs/models/components/chatchoice.mdx index 9c7ef7a89..772de95ca 100644 --- a/docs/models/components/chatchoice.mdx +++ b/docs/models/components/chatchoice.mdx @@ -9,7 +9,7 @@ Chat completion choice | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | -| `Index` | `int64` | :heavy_check_mark: | Choice index | 0 | -| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | -| `Message` | [components.ChatAssistantMessage](../../models/components/chatassistantmessage.mdx) | :heavy_check_mark: | Assistant message for requests and responses | \{
"content": "What is the capital of France?",
"role": "user"
} | \ No newline at end of file +| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | ✅ | N/A | stop | +| `Index` | `int64` | ✅ | Choice index | 0 | +| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | ➖ | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | +| `Message` | [components.ChatAssistantMessage](../../models/components/chatassistantmessage.mdx) | ✅ | Assistant message for requests and responses | \{
"content": "What is the capital of France?",
"role": "user"
} | \ No newline at end of file diff --git a/docs/models/components/chatcontentaudio.mdx b/docs/models/components/chatcontentaudio.mdx index 2b0157064..b0b43dc7a 100644 --- a/docs/models/components/chatcontentaudio.mdx +++ b/docs/models/components/chatcontentaudio.mdx @@ -9,5 +9,5 @@ Audio input content part. Supported audio formats vary by provider. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.ChatContentAudioInputAudio](../../models/components/chatcontentaudioinputaudio.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentAudioType](../../models/components/chatcontentaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `InputAudio` | [components.ChatContentAudioInputAudio](../../models/components/chatcontentaudioinputaudio.mdx) | ✅ | N/A | +| `Type` | [components.ChatContentAudioType](../../models/components/chatcontentaudiotype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentaudioinputaudio.mdx b/docs/models/components/chatcontentaudioinputaudio.mdx index bc976337c..986694bac 100644 --- a/docs/models/components/chatcontentaudioinputaudio.mdx +++ b/docs/models/components/chatcontentaudioinputaudio.mdx @@ -6,5 +6,5 @@ title: "ChatContentAudioInputAudio" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | Base64 encoded audio data | -| `Format` | `string` | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file +| `Data` | `string` | ✅ | Base64 encoded audio data | +| `Format` | `string` | ✅ | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file diff --git a/docs/models/components/chatcontentcachecontrol.mdx b/docs/models/components/chatcontentcachecontrol.mdx index 110129bb8..8e14f84d1 100644 --- a/docs/models/components/chatcontentcachecontrol.mdx +++ b/docs/models/components/chatcontentcachecontrol.mdx @@ -9,5 +9,5 @@ Anthropic-style cache breakpoint for the content part. Interchangeable with the | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `Type` | [components.ChatContentCacheControlType](../../models/components/chatcontentcachecontroltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | +| `Type` | [components.ChatContentCacheControlType](../../models/components/chatcontentcachecontroltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatcontentfile.mdx b/docs/models/components/chatcontentfile.mdx index 49c1fcbdf..208f3a5a1 100644 --- a/docs/models/components/chatcontentfile.mdx +++ b/docs/models/components/chatcontentfile.mdx @@ -9,5 +9,5 @@ File content part for document processing | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `File` | [components.ChatContentFileFile](../../models/components/chatcontentfilefile.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentFileType](../../models/components/chatcontentfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `File` | [components.ChatContentFileFile](../../models/components/chatcontentfilefile.mdx) | ✅ | N/A | +| `Type` | [components.ChatContentFileType](../../models/components/chatcontentfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentfilefile.mdx b/docs/models/components/chatcontentfilefile.mdx index 2769ae67a..164a096ea 100644 --- a/docs/models/components/chatcontentfilefile.mdx +++ b/docs/models/components/chatcontentfilefile.mdx @@ -6,6 +6,6 @@ title: "ChatContentFileFile" | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `FileData` | `*string` | :heavy_minus_sign: | File content as base64 data URL or URL | -| `FileID` | `*string` | :heavy_minus_sign: | File ID for previously uploaded files | -| `Filename` | `*string` | :heavy_minus_sign: | Original filename | \ No newline at end of file +| `FileData` | `*string` | ➖ | File content as base64 data URL or URL | +| `FileID` | `*string` | ➖ | File ID for previously uploaded files | +| `Filename` | `*string` | ➖ | Original filename | \ No newline at end of file diff --git a/docs/models/components/chatcontentimage.mdx b/docs/models/components/chatcontentimage.mdx index 7978182c6..d721b60bb 100644 --- a/docs/models/components/chatcontentimage.mdx +++ b/docs/models/components/chatcontentimage.mdx @@ -9,5 +9,5 @@ Image content part for vision models | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ChatContentImageImageURL](../../models/components/chatcontentimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentImageType](../../models/components/chatcontentimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.ChatContentImageImageURL](../../models/components/chatcontentimageimageurl.mdx) | ✅ | N/A | +| `Type` | [components.ChatContentImageType](../../models/components/chatcontentimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentimageimageurl.mdx b/docs/models/components/chatcontentimageimageurl.mdx index 4e9eaec26..734580ead 100644 --- a/docs/models/components/chatcontentimageimageurl.mdx +++ b/docs/models/components/chatcontentimageimageurl.mdx @@ -6,5 +6,5 @@ title: "ChatContentImageImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Detail` | [*components.ChatContentImageDetail](../../models/components/chatcontentimagedetail.mdx) | :heavy_minus_sign: | Image detail level for vision models. `original` is an OpenRouter extension (not in the OpenAI Chat Completions spec) requesting true original-resolution media; it is downgraded to `high` for providers that lack an original-resolution tier. | -| `URL` | `string` | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file +| `Detail` | [*components.ChatContentImageDetail](../../models/components/chatcontentimagedetail.mdx) | ➖ | Image detail level for vision models. `original` is an OpenRouter extension (not in the OpenAI Chat Completions spec) requesting true original-resolution media; it is downgraded to `high` for providers that lack an original-resolution tier. | +| `URL` | `string` | ✅ | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/docs/models/components/chatcontenttext.mdx b/docs/models/components/chatcontenttext.mdx index 923d6d42a..886672ee4 100644 --- a/docs/models/components/chatcontenttext.mdx +++ b/docs/models/components/chatcontenttext.mdx @@ -9,7 +9,7 @@ Text content part | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol.mdx) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | -| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint.mdx)] | :heavy_minus_sign: | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | -| `Text` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.ChatContentTextType](../../models/components/chatcontenttexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol.mdx) | ➖ | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | +| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint.mdx)] | ➖ | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | +| `Text` | `string` | ✅ | N/A | | +| `Type` | [components.ChatContentTextType](../../models/components/chatcontenttexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatcontentvideo.mdx b/docs/models/components/chatcontentvideo.mdx index 9b545f87b..35ba5256e 100644 --- a/docs/models/components/chatcontentvideo.mdx +++ b/docs/models/components/chatcontentvideo.mdx @@ -9,5 +9,5 @@ Video input content part | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.ChatContentVideoType](../../models/components/chatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | -| `VideoURL` | [components.ChatContentVideoInput](../../models/components/chatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `Type` | [components.ChatContentVideoType](../../models/components/chatcontentvideotype.mdx) | ✅ | N/A | | +| `VideoURL` | [components.ChatContentVideoInput](../../models/components/chatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/components/chatcontentvideoinput.mdx b/docs/models/components/chatcontentvideoinput.mdx index 2bd6a8619..623c8b210 100644 --- a/docs/models/components/chatcontentvideoinput.mdx +++ b/docs/models/components/chatcontentvideoinput.mdx @@ -9,5 +9,5 @@ Video input object | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Processing` | [*components.ChatContentVideoInputProcessing](../../models/components/chatcontentvideoinputprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `URL` | `string` | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file +| `Processing` | [*components.ChatContentVideoInputProcessing](../../models/components/chatcontentvideoinputprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `URL` | `string` | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/models/components/chatdebugoptions.mdx b/docs/models/components/chatdebugoptions.mdx index 7d820388a..d9d0aa32f 100644 --- a/docs/models/components/chatdebugoptions.mdx +++ b/docs/models/components/chatdebugoptions.mdx @@ -9,4 +9,4 @@ Debug options for inspecting request transformations (streaming only) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `EchoUpstreamBody` | `*bool` | :heavy_minus_sign: | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file +| `EchoUpstreamBody` | `*bool` | ➖ | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file diff --git a/docs/models/components/chatdevelopermessage.mdx b/docs/models/components/chatdevelopermessage.mdx index 71c2c2a9d..a602449fd 100644 --- a/docs/models/components/chatdevelopermessage.mdx +++ b/docs/models/components/chatdevelopermessage.mdx @@ -9,7 +9,7 @@ Developer message | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ConfigurationUpdate` | optionalnullable.OptionalNullable[[components.ChatDeveloperMessageConfigurationUpdate](../../models/components/chatdevelopermessageconfigurationupdate.mdx)] | :heavy_minus_sign: | OpenRouter extension. Same as the system message `configuration_update`: changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. | \{
"reasoning": \{
"effort": "low"
}
} | -| `Content` | [components.ChatDeveloperMessageContent](../../models/components/chatdevelopermessagecontent.mdx) | :heavy_check_mark: | Developer message content | This is a message from the developer. | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for the developer message | Developer | -| `Role` | [components.ChatDeveloperMessageRole](../../models/components/chatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ConfigurationUpdate` | optionalnullable.OptionalNullable[[components.ChatDeveloperMessageConfigurationUpdate](../../models/components/chatdevelopermessageconfigurationupdate.mdx)] | ➖ | OpenRouter extension. Same as the system message `configuration_update`: changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. | \{
"reasoning": \{
"effort": "low"
}
} | +| `Content` | [components.ChatDeveloperMessageContent](../../models/components/chatdevelopermessagecontent.mdx) | ✅ | Developer message content | This is a message from the developer. | +| `Name` | `*string` | ➖ | Optional name for the developer message | Developer | +| `Role` | [components.ChatDeveloperMessageRole](../../models/components/chatdevelopermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatdevelopermessageconfigurationupdate.mdx b/docs/models/components/chatdevelopermessageconfigurationupdate.mdx index ebc763776..638ae159f 100644 --- a/docs/models/components/chatdevelopermessageconfigurationupdate.mdx +++ b/docs/models/components/chatdevelopermessageconfigurationupdate.mdx @@ -9,4 +9,4 @@ OpenRouter extension. Same as the system message `configuration_update`: changes | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file +| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file diff --git a/docs/models/components/chatdynamicservertool.mdx b/docs/models/components/chatdynamicservertool.mdx index 0adb257b8..29c3aa6a3 100644 --- a/docs/models/components/chatdynamicservertool.mdx +++ b/docs/models/components/chatdynamicservertool.mdx @@ -9,5 +9,5 @@ Generic OpenRouter server-tool envelope. `type` names a registered server tool ( | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Parameters` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Type` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Parameters` | map[string]`any` | ➖ | N/A | +| `Type` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatformatgrammarconfig.mdx b/docs/models/components/chatformatgrammarconfig.mdx index 27fd2d493..ad5db7863 100644 --- a/docs/models/components/chatformatgrammarconfig.mdx +++ b/docs/models/components/chatformatgrammarconfig.mdx @@ -9,5 +9,5 @@ Custom grammar response format | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Grammar` | `string` | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | -| `Type` | [components.ChatFormatGrammarConfigType](../../models/components/chatformatgrammarconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Grammar` | `string` | ✅ | Custom grammar for text generation | root ::= "yes" \| "no" | +| `Type` | [components.ChatFormatGrammarConfigType](../../models/components/chatformatgrammarconfigtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatformatjsonobjectconfig.mdx b/docs/models/components/chatformatjsonobjectconfig.mdx index dd1a41d3d..ade59977f 100644 --- a/docs/models/components/chatformatjsonobjectconfig.mdx +++ b/docs/models/components/chatformatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Type` | [components.ChatFormatJSONObjectConfigType](../../models/components/chatformatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatJSONObjectConfigType](../../models/components/chatformatjsonobjectconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatformatjsonschemaconfig.mdx b/docs/models/components/chatformatjsonschemaconfig.mdx index 269e7ca5a..47f1d0b8b 100644 --- a/docs/models/components/chatformatjsonschemaconfig.mdx +++ b/docs/models/components/chatformatjsonschemaconfig.mdx @@ -9,5 +9,5 @@ JSON Schema response format for structured outputs | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `JSONSchema` | [components.ChatJSONSchemaConfig](../../models/components/chatjsonschemaconfig.mdx) | :heavy_check_mark: | JSON Schema configuration object | \{
"description": "A mathematical response",
"name": "math_response",
"schema": \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
},
"strict": true
} | -| `Type` | [components.ChatFormatJSONSchemaConfigType](../../models/components/chatformatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `JSONSchema` | [components.ChatJSONSchemaConfig](../../models/components/chatjsonschemaconfig.mdx) | ✅ | JSON Schema configuration object | \{
"description": "A mathematical response",
"name": "math_response",
"schema": \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
},
"strict": true
} | +| `Type` | [components.ChatFormatJSONSchemaConfigType](../../models/components/chatformatjsonschemaconfigtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatformatpythonconfig.mdx b/docs/models/components/chatformatpythonconfig.mdx index 5930db0a9..dab4ab7e5 100644 --- a/docs/models/components/chatformatpythonconfig.mdx +++ b/docs/models/components/chatformatpythonconfig.mdx @@ -9,4 +9,4 @@ Python code response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.ChatFormatPythonConfigType](../../models/components/chatformatpythonconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatPythonConfigType](../../models/components/chatformatpythonconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatformattextconfig.mdx b/docs/models/components/chatformattextconfig.mdx index 104071e79..26ddc1ccc 100644 --- a/docs/models/components/chatformattextconfig.mdx +++ b/docs/models/components/chatformattextconfig.mdx @@ -9,4 +9,4 @@ Default text response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Type` | [components.ChatFormatTextConfigType](../../models/components/chatformattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatTextConfigType](../../models/components/chatformattextconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatfunctiontoolfunction.mdx b/docs/models/components/chatfunctiontoolfunction.mdx index 7abed15ad..9dc7bab58 100644 --- a/docs/models/components/chatfunctiontoolfunction.mdx +++ b/docs/models/components/chatfunctiontoolfunction.mdx @@ -6,6 +6,6 @@ title: "ChatFunctionToolFunction" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol.mdx) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | -| `Function` | [components.ChatFunctionToolFunctionFunction](../../models/components/chatfunctiontoolfunctionfunction.mdx) | :heavy_check_mark: | Function definition for tool calling | \{
"description": "Get the current weather for a location",
"name": "get_weather",
"parameters": \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
}
} | -| `Type` | [components.ChatFunctionToolType](../../models/components/chatfunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol.mdx) | ➖ | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | +| `Function` | [components.ChatFunctionToolFunctionFunction](../../models/components/chatfunctiontoolfunctionfunction.mdx) | ✅ | Function definition for tool calling | \{
"description": "Get the current weather for a location",
"name": "get_weather",
"parameters": \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
}
} | +| `Type` | [components.ChatFunctionToolType](../../models/components/chatfunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatfunctiontoolfunctionfunction.mdx b/docs/models/components/chatfunctiontoolfunctionfunction.mdx index 00f6fe123..3a9010127 100644 --- a/docs/models/components/chatfunctiontoolfunctionfunction.mdx +++ b/docs/models/components/chatfunctiontoolfunctionfunction.mdx @@ -9,7 +9,7 @@ Function definition for tool calling | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | `*string` | :heavy_minus_sign: | Function description for the model | Get the current weather for a location | -| `Name` | `string` | :heavy_check_mark: | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | -| `Parameters` | map[string]`any` | :heavy_minus_sign: | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file +| `Description` | `*string` | ➖ | Function description for the model | Get the current weather for a location | +| `Name` | `string` | ✅ | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | +| `Parameters` | map[string]`any` | ➖ | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/models/components/chatjsonschemaconfig.mdx b/docs/models/components/chatjsonschemaconfig.mdx index c6ab0147b..01c6a35a0 100644 --- a/docs/models/components/chatjsonschemaconfig.mdx +++ b/docs/models/components/chatjsonschemaconfig.mdx @@ -9,7 +9,7 @@ JSON Schema configuration object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Description` | `*string` | :heavy_minus_sign: | Schema description for the model | A mathematical response | -| `Name` | `string` | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | -| `Schema` | map[string]`any` | :heavy_minus_sign: | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file +| `Description` | `*string` | ➖ | Schema description for the model | A mathematical response | +| `Name` | `string` | ✅ | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | +| `Schema` | map[string]`any` | ➖ | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/models/components/chatnamedtoolchoice.mdx b/docs/models/components/chatnamedtoolchoice.mdx index d3a4959c4..55ba9b606 100644 --- a/docs/models/components/chatnamedtoolchoice.mdx +++ b/docs/models/components/chatnamedtoolchoice.mdx @@ -9,5 +9,5 @@ Named tool choice for specific function | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Function` | [components.ChatNamedToolChoiceFunction](../../models/components/chatnamedtoolchoicefunction.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatNamedToolChoiceType](../../models/components/chatnamedtoolchoicetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Function` | [components.ChatNamedToolChoiceFunction](../../models/components/chatnamedtoolchoicefunction.mdx) | ✅ | N/A | +| `Type` | [components.ChatNamedToolChoiceType](../../models/components/chatnamedtoolchoicetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chatnamedtoolchoicefunction.mdx b/docs/models/components/chatnamedtoolchoicefunction.mdx index 2d9e7a888..f9657c9b3 100644 --- a/docs/models/components/chatnamedtoolchoicefunction.mdx +++ b/docs/models/components/chatnamedtoolchoicefunction.mdx @@ -6,4 +6,4 @@ title: "ChatNamedToolChoiceFunction" | Field | Type | Required | Description | Example | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | -| `Name` | `string` | :heavy_check_mark: | Function name to call | get_weather | \ No newline at end of file +| `Name` | `string` | ✅ | Function name to call | get_weather | \ No newline at end of file diff --git a/docs/models/components/chatrequest.mdx b/docs/models/components/chatrequest.mdx index 116042e85..64a3a1fe5 100644 --- a/docs/models/components/chatrequest.mdx +++ b/docs/models/components/chatrequest.mdx @@ -9,44 +9,44 @@ Chat completion request parameters | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Debug` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | -| `LogitBias` | optionalnullable.OptionalNullable[map[string]`float64`] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | -| `Logprobs` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Return log probabilities | false | -| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `Messages` | [][components.ChatMessages](../../models/components/chatmessages.mdx) | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `Metadata` | map[string]`string` | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | -| `MinP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum probability threshold relative to the most likely token. Tokens with probability below min_p * (probability of top token) are filtered out. Not all providers support this parameter. | 0.1 | -| `Modalities` | [][components.Modality](../../models/components/modality.mdx) | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `Model` | `*string` | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | -| `Models` | []`string` | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `ParallelToolCalls` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enable parallel function calling during tool use. When true, the model may generate multiple tool calls in a single response. | true | -| `Plugins` | [][components.ChatRequestPlugin](../../models/components/chatrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `Prediction` | optionalnullable.OptionalNullable[[components.Prediction](../../models/components/prediction.mdx)] | :heavy_minus_sign: | Static predicted output content. Supported models can use this to reduce latency when much of the response is known in advance. | \{
"content": "Expected response",
"type": "content"
} | -| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `Reasoning` | [*components.ChatRequestReasoning](../../models/components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `ReasoningEffort` | optionalnullable.OptionalNullable[[components.ChatRequestReasoningEffort](../../models/components/chatrequestreasoningeffort.mdx)] | :heavy_minus_sign: | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | -| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Penalizes tokens based on how much they have already appeared in the text. A value of 1.0 means no penalty. Values above 1.0 penalize repeated tokens more strongly. Not all providers support this parameter. | 1 | -| `ResponseFormat` | [*components.ResponseFormat](../../models/components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | -| `Seed` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `ServiceTier` | optionalnullable.OptionalNullable[[components.ChatRequestServiceTier](../../models/components/chatrequestservicetier.mdx)] | :heavy_minus_sign: | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | auto | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `Stop` | optionalnullable.OptionalNullable[[components.Stop](../../models/components/stop.mdx)] | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `Stream` | `*bool` | :heavy_minus_sign: | Enable streaming response | false | -| `StreamOptions` | optionalnullable.OptionalNullable[[components.ChatStreamOptions](../../models/components/chatstreamoptions.mdx)] | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | -| `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `ToolChoice` | [*components.ChatToolChoice](../../models/components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | -| `Tools` | [][components.ChatFunctionTool](../../models/components/chatfunctiontool.mdx) | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `TopA` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | -| `TopK` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Limits the model to choose from the top K most likely tokens at each step. A value of 1 means the model will always pick the most likely next token. Not all providers support this parameter. | 40 | -| `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | :heavy_minus_sign: | Per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Debug` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | +| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | ➖ | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | +| `LogitBias` | optionalnullable.OptionalNullable[map[string]`float64`] | ➖ | Token logit bias adjustments | \{
"50256": -100
} | +| `Logprobs` | optionalnullable.OptionalNullable[`bool`] | ➖ | Return log probabilities | false | +| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum tokens in completion | 100 | +| `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `Messages` | [][components.ChatMessages](../../models/components/chatmessages.mdx) | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `Metadata` | map[string]`string` | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | +| `MinP` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum probability threshold relative to the most likely token. Tokens with probability below min_p * (probability of top token) are filtered out. Not all providers support this parameter. | 0.1 | +| `Modalities` | [][components.Modality](../../models/components/modality.mdx) | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `Model` | `*string` | ➖ | Model to use for completion | openai/gpt-4 | +| `Models` | []`string` | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `ParallelToolCalls` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enable parallel function calling during tool use. When true, the model may generate multiple tool calls in a single response. | true | +| `Plugins` | [][components.ChatRequestPlugin](../../models/components/chatrequestplugin.mdx) | ➖ | Plugins you want to enable for this request, including their settings. | | +| `Prediction` | optionalnullable.OptionalNullable[[components.Prediction](../../models/components/prediction.mdx)] | ➖ | Static predicted output content. Supported models can use this to reduce latency when much of the response is known in advance. | \{
"content": "Expected response",
"type": "content"
} | +| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | Presence penalty (-2.0 to 2.0) | 0 | +| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `Reasoning` | [*components.ChatRequestReasoning](../../models/components/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `ReasoningEffort` | optionalnullable.OptionalNullable[[components.ChatRequestReasoningEffort](../../models/components/chatrequestreasoningeffort.mdx)] | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | +| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | Penalizes tokens based on how much they have already appeared in the text. A value of 1.0 means no penalty. Values above 1.0 penalize repeated tokens more strongly. Not all providers support this parameter. | 1 | +| `ResponseFormat` | [*components.ResponseFormat](../../models/components/responseformat.mdx) | ➖ | Response format configuration | \{
"type": "json_object"
} | +| `Seed` | optionalnullable.OptionalNullable[`int64`] | ➖ | Random seed for deterministic outputs | 42 | +| `ServiceTier` | optionalnullable.OptionalNullable[[components.ChatRequestServiceTier](../../models/components/chatrequestservicetier.mdx)] | ➖ | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | auto | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `Stop` | optionalnullable.OptionalNullable[[components.Stop](../../models/components/stop.mdx)] | ➖ | Stop sequences (up to 4) | [
"\n"
] | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `Stream` | `*bool` | ➖ | Enable streaming response | false | +| `StreamOptions` | optionalnullable.OptionalNullable[[components.ChatStreamOptions](../../models/components/chatstreamoptions.mdx)] | ➖ | Streaming configuration options | \{
"include_usage": true
} | +| `Temperature` | optionalnullable.OptionalNullable[`float64`] | ➖ | Sampling temperature (0-2) | 0.7 | +| `ToolChoice` | [*components.ChatToolChoice](../../models/components/chattoolchoice.mdx) | ➖ | Tool choice configuration | auto | +| `Tools` | [][components.ChatFunctionTool](../../models/components/chatfunctiontool.mdx) | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `TopA` | optionalnullable.OptionalNullable[`float64`] | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | +| `TopK` | optionalnullable.OptionalNullable[`int64`] | ➖ | Limits the model to choose from the top K most likely tokens at each step. A value of 1 means the model will always pick the most likely next token. Not all providers support this parameter. | 40 | +| `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of top log probabilities to return (0-20) | 5 | +| `TopP` | optionalnullable.OptionalNullable[`float64`] | ➖ | Nucleus sampling parameter (0-1) | 1 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | ➖ | Per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | \ No newline at end of file diff --git a/docs/models/components/chatrequestreasoning.mdx b/docs/models/components/chatrequestreasoning.mdx index bd0c82b7a..58cde929a 100644 --- a/docs/models/components/chatrequestreasoning.mdx +++ b/docs/models/components/chatrequestreasoning.mdx @@ -9,5 +9,5 @@ Configuration options for reasoning models | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.ChatRequestEffort](../../models/components/chatrequesteffort.mdx)] | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | -| `Summary` | optionalnullable.OptionalNullable[[components.ChatReasoningSummaryVerbosityEnum](../../models/components/chatreasoningsummaryverbosityenum.mdx)] | :heavy_minus_sign: | N/A | concise | \ No newline at end of file +| `Effort` | optionalnullable.OptionalNullable[[components.ChatRequestEffort](../../models/components/chatrequesteffort.mdx)] | ➖ | Constrains effort on reasoning for reasoning models | medium | +| `Summary` | optionalnullable.OptionalNullable[[components.ChatReasoningSummaryVerbosityEnum](../../models/components/chatreasoningsummaryverbosityenum.mdx)] | ➖ | N/A | concise | \ No newline at end of file diff --git a/docs/models/components/chatresult.mdx b/docs/models/components/chatresult.mdx index 6365d75c9..d454178d3 100644 --- a/docs/models/components/chatresult.mdx +++ b/docs/models/components/chatresult.mdx @@ -9,12 +9,12 @@ Chat completion response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.ChatChoice](../../models/components/chatchoice.mdx) | :heavy_check_mark: | List of completion choices | | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `ID` | `string` | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | -| `Model` | `string` | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `Object` | [components.ChatResultObject](../../models/components/chatresultobject.mdx) | :heavy_check_mark: | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `SystemFingerprint` | `*string` | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | -| `Usage` | [*components.ChatUsage](../../models/components/chatusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file +| `Choices` | [][components.ChatChoice](../../models/components/chatchoice.mdx) | ✅ | List of completion choices | | +| `Created` | `int64` | ✅ | Unix timestamp of creation | 1677652288 | +| `ID` | `string` | ✅ | Unique completion identifier | chatcmpl-123 | +| `Model` | `string` | ✅ | Model used for completion | openai/gpt-4 | +| `Object` | [components.ChatResultObject](../../models/components/chatresultobject.mdx) | ✅ | N/A | | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | default | +| `SystemFingerprint` | `*string` | ✅ | System fingerprint | fp_44709d6fcb | +| `Usage` | [*components.ChatUsage](../../models/components/chatusage.mdx) | ➖ | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file diff --git a/docs/models/components/chatsearchmodelsservertool.mdx b/docs/models/components/chatsearchmodelsservertool.mdx index 55ce5ec93..38b554934 100644 --- a/docs/models/components/chatsearchmodelsservertool.mdx +++ b/docs/models/components/chatsearchmodelsservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.ChatSearchModelsServerToolType](../../models/components/chatsearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.ChatSearchModelsServerToolType](../../models/components/chatsearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatservertoolchoice.mdx b/docs/models/components/chatservertoolchoice.mdx index b75d04c8b..977d0ea33 100644 --- a/docs/models/components/chatservertoolchoice.mdx +++ b/docs/models/components/chatservertoolchoice.mdx @@ -9,4 +9,4 @@ OpenRouter extension: force a specific server tool by naming it directly in `too | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Type` | `string` | :heavy_check_mark: | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file +| `Type` | `string` | ✅ | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file diff --git a/docs/models/components/chatstreamchoice.mdx b/docs/models/components/chatstreamchoice.mdx index ace80d155..6b53ace15 100644 --- a/docs/models/components/chatstreamchoice.mdx +++ b/docs/models/components/chatstreamchoice.mdx @@ -9,7 +9,7 @@ Streaming completion choice chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Delta` | [components.ChatStreamDelta](../../models/components/chatstreamdelta.mdx) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | -| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | -| `Index` | `int64` | :heavy_check_mark: | Choice index | 0 | -| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | \ No newline at end of file +| `Delta` | [components.ChatStreamDelta](../../models/components/chatstreamdelta.mdx) | ✅ | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | +| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | ✅ | N/A | stop | +| `Index` | `int64` | ✅ | Choice index | 0 | +| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | ➖ | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | \ No newline at end of file diff --git a/docs/models/components/chatstreamchunk.mdx b/docs/models/components/chatstreamchunk.mdx index 2ac55c5cb..1c5362225 100644 --- a/docs/models/components/chatstreamchunk.mdx +++ b/docs/models/components/chatstreamchunk.mdx @@ -9,13 +9,13 @@ Streaming chat completion chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.ChatStreamChoice](../../models/components/chatstreamchoice.mdx) | :heavy_check_mark: | List of streaming chunk choices | | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `Error` | [*components.ChatStreamChunkError](../../models/components/chatstreamchunkerror.mdx) | :heavy_minus_sign: | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | -| `ID` | `string` | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | -| `Model` | `string` | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `Object` | [components.ChatStreamChunkObject](../../models/components/chatstreamchunkobject.mdx) | :heavy_check_mark: | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `SystemFingerprint` | `*string` | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | -| `Usage` | [*components.ChatUsage](../../models/components/chatusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file +| `Choices` | [][components.ChatStreamChoice](../../models/components/chatstreamchoice.mdx) | ✅ | List of streaming chunk choices | | +| `Created` | `int64` | ✅ | Unix timestamp of creation | 1677652288 | +| `Error` | [*components.ChatStreamChunkError](../../models/components/chatstreamchunkerror.mdx) | ➖ | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | +| `ID` | `string` | ✅ | Unique chunk identifier | chatcmpl-123 | +| `Model` | `string` | ✅ | Model used for completion | openai/gpt-4 | +| `Object` | [components.ChatStreamChunkObject](../../models/components/chatstreamchunkobject.mdx) | ✅ | N/A | | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | default | +| `SystemFingerprint` | `*string` | ➖ | System fingerprint | fp_44709d6fcb | +| `Usage` | [*components.ChatUsage](../../models/components/chatusage.mdx) | ➖ | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file diff --git a/docs/models/components/chatstreamchunkerror.mdx b/docs/models/components/chatstreamchunkerror.mdx index b5d7abc14..a6319b92c 100644 --- a/docs/models/components/chatstreamchunkerror.mdx +++ b/docs/models/components/chatstreamchunkerror.mdx @@ -9,6 +9,6 @@ Error information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `Code` | `int` | :heavy_check_mark: | Error code | 429 | -| `Message` | `string` | :heavy_check_mark: | Error message | Rate limit exceeded | -| `Metadata` | [*components.ChatStreamChunkMetadata](../../models/components/chatstreamchunkmetadata.mdx) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file +| `Code` | `int` | ✅ | Error code | 429 | +| `Message` | `string` | ✅ | Error message | Rate limit exceeded | +| `Metadata` | [*components.ChatStreamChunkMetadata](../../models/components/chatstreamchunkmetadata.mdx) | ➖ | Structured error metadata | | \ No newline at end of file diff --git a/docs/models/components/chatstreamchunkmetadata.mdx b/docs/models/components/chatstreamchunkmetadata.mdx index 249b702b3..b67840432 100644 --- a/docs/models/components/chatstreamchunkmetadata.mdx +++ b/docs/models/components/chatstreamchunkmetadata.mdx @@ -9,5 +9,5 @@ Structured error metadata | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ErrorType` | [components.APIErrorType](../../models/components/apierrortype.mdx) | :heavy_check_mark: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `ProviderCode` | `*string` | :heavy_minus_sign: | Upstream provider-specific error code, when available | | \ No newline at end of file +| `ErrorType` | [components.APIErrorType](../../models/components/apierrortype.mdx) | ✅ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `ProviderCode` | `*string` | ➖ | Upstream provider-specific error code, when available | | \ No newline at end of file diff --git a/docs/models/components/chatstreamdelta.mdx b/docs/models/components/chatstreamdelta.mdx index e09e1eec9..722d01483 100644 --- a/docs/models/components/chatstreamdelta.mdx +++ b/docs/models/components/chatstreamdelta.mdx @@ -9,10 +9,10 @@ Delta changes in streaming response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | :heavy_minus_sign: | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | -| `Content` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Message content delta | Hello | -| `Reasoning` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Reasoning content delta | I need to | -| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | -| `Refusal` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Refusal message delta | null | -| `Role` | [*components.ChatStreamDeltaRole](../../models/components/chatstreamdeltarole.mdx) | :heavy_minus_sign: | The role of the message author | assistant | -| `ToolCalls` | [][components.ChatStreamToolCall](../../models/components/chatstreamtoolcall.mdx) | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file +| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | ➖ | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `Content` | optionalnullable.OptionalNullable[`string`] | ➖ | Message content delta | Hello | +| `Reasoning` | optionalnullable.OptionalNullable[`string`] | ➖ | Reasoning content delta | I need to | +| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | +| `Refusal` | optionalnullable.OptionalNullable[`string`] | ➖ | Refusal message delta | null | +| `Role` | [*components.ChatStreamDeltaRole](../../models/components/chatstreamdeltarole.mdx) | ➖ | The role of the message author | assistant | +| `ToolCalls` | [][components.ChatStreamToolCall](../../models/components/chatstreamtoolcall.mdx) | ➖ | Tool calls delta | | \ No newline at end of file diff --git a/docs/models/components/chatstreamingresponse.mdx b/docs/models/components/chatstreamingresponse.mdx index fffbbb270..f65ce6974 100644 --- a/docs/models/components/chatstreamingresponse.mdx +++ b/docs/models/components/chatstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ChatStreamingResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ChatStreamChunk](../../models/components/chatstreamchunk.mdx) | :heavy_check_mark: | Streaming chat completion chunk | \{
"choices": [
\{
"delta": \{
"content": "Hello",
"role": "assistant"
},
"finish_reason": null,
"index": 0
}
],
"created": 1677652288,
"id": "chatcmpl-123",
"model": "openai/gpt-4",
"object": "chat.completion.chunk"
} | \ No newline at end of file +| `Data` | [components.ChatStreamChunk](../../models/components/chatstreamchunk.mdx) | ✅ | Streaming chat completion chunk | \{
"choices": [
\{
"delta": \{
"content": "Hello",
"role": "assistant"
},
"finish_reason": null,
"index": 0
}
],
"created": 1677652288,
"id": "chatcmpl-123",
"model": "openai/gpt-4",
"object": "chat.completion.chunk"
} | \ No newline at end of file diff --git a/docs/models/components/chatstreamoptions.mdx b/docs/models/components/chatstreamoptions.mdx index 186c02d0c..ebce1f51e 100644 --- a/docs/models/components/chatstreamoptions.mdx +++ b/docs/models/components/chatstreamoptions.mdx @@ -9,4 +9,4 @@ Streaming configuration options | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ~~`IncludeUsage`~~ | `*bool` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file +| ~~`IncludeUsage`~~ | `*bool` | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file diff --git a/docs/models/components/chatstreamtoolcall.mdx b/docs/models/components/chatstreamtoolcall.mdx index 6f5e9e459..25a05887d 100644 --- a/docs/models/components/chatstreamtoolcall.mdx +++ b/docs/models/components/chatstreamtoolcall.mdx @@ -9,7 +9,7 @@ Tool call delta for streaming responses | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Function` | [*components.ChatStreamToolCallFunction](../../models/components/chatstreamtoolcallfunction.mdx) | :heavy_minus_sign: | Function call details | | -| `ID` | `*string` | :heavy_minus_sign: | Tool call identifier | call_abc123 | -| `Index` | `int64` | :heavy_check_mark: | Tool call index in the array | 0 | -| `Type` | [*components.ChatStreamToolCallType](../../models/components/chatstreamtoolcalltype.mdx) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file +| `Function` | [*components.ChatStreamToolCallFunction](../../models/components/chatstreamtoolcallfunction.mdx) | ➖ | Function call details | | +| `ID` | `*string` | ➖ | Tool call identifier | call_abc123 | +| `Index` | `int64` | ✅ | Tool call index in the array | 0 | +| `Type` | [*components.ChatStreamToolCallType](../../models/components/chatstreamtoolcalltype.mdx) | ➖ | Tool call type | function | \ No newline at end of file diff --git a/docs/models/components/chatstreamtoolcallfunction.mdx b/docs/models/components/chatstreamtoolcallfunction.mdx index c1d33edba..eacf9a285 100644 --- a/docs/models/components/chatstreamtoolcallfunction.mdx +++ b/docs/models/components/chatstreamtoolcallfunction.mdx @@ -9,5 +9,5 @@ Function call details | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `Arguments` | `*string` | :heavy_minus_sign: | Function arguments as JSON string | \{"location": "..."} | -| `Name` | `*string` | :heavy_minus_sign: | Function name | get_weather | \ No newline at end of file +| `Arguments` | `*string` | ➖ | Function arguments as JSON string | \{"location": "..."} | +| `Name` | `*string` | ➖ | Function name | get_weather | \ No newline at end of file diff --git a/docs/models/components/chatsystemmessage.mdx b/docs/models/components/chatsystemmessage.mdx index 376954a3b..fc560d3a1 100644 --- a/docs/models/components/chatsystemmessage.mdx +++ b/docs/models/components/chatsystemmessage.mdx @@ -9,7 +9,7 @@ System message for setting behavior | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ConfigurationUpdate` | optionalnullable.OptionalNullable[[components.ChatSystemMessageConfigurationUpdate](../../models/components/chatsystemmessageconfigurationupdate.mdx)] | :heavy_minus_sign: | OpenRouter extension. Changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. Place it on a content-less system message (`content: ""`) directly before the user message it should apply to, and keep it at that position in later requests. Equivalent to the OpenAI Responses `configuration_update` input item and the Anthropic Messages per-message `output_config.effort`. | \{
"reasoning": \{
"effort": "low"
}
} | -| `Content` | [components.ChatSystemMessageContent](../../models/components/chatsystemmessagecontent.mdx) | :heavy_check_mark: | System message content | You are a helpful assistant. | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for the system message | Assistant Config | -| `Role` | [components.ChatSystemMessageRole](../../models/components/chatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ConfigurationUpdate` | optionalnullable.OptionalNullable[[components.ChatSystemMessageConfigurationUpdate](../../models/components/chatsystemmessageconfigurationupdate.mdx)] | ➖ | OpenRouter extension. Changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. Place it on a content-less system message (`content: ""`) directly before the user message it should apply to, and keep it at that position in later requests. Equivalent to the OpenAI Responses `configuration_update` input item and the Anthropic Messages per-message `output_config.effort`. | \{
"reasoning": \{
"effort": "low"
}
} | +| `Content` | [components.ChatSystemMessageContent](../../models/components/chatsystemmessagecontent.mdx) | ✅ | System message content | You are a helpful assistant. | +| `Name` | `*string` | ➖ | Optional name for the system message | Assistant Config | +| `Role` | [components.ChatSystemMessageRole](../../models/components/chatsystemmessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatsystemmessageconfigurationupdate.mdx b/docs/models/components/chatsystemmessageconfigurationupdate.mdx index 32d6713ff..b9d3c69c1 100644 --- a/docs/models/components/chatsystemmessageconfigurationupdate.mdx +++ b/docs/models/components/chatsystemmessageconfigurationupdate.mdx @@ -9,4 +9,4 @@ OpenRouter extension. Changes reasoning effort from this point in the conversati | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file +| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file diff --git a/docs/models/components/chattokenlogprob.mdx b/docs/models/components/chattokenlogprob.mdx index b1543a482..247da450e 100644 --- a/docs/models/components/chattokenlogprob.mdx +++ b/docs/models/components/chattokenlogprob.mdx @@ -9,7 +9,7 @@ Token log probability information | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | UTF-8 bytes of the token | -| `Logprob` | `float64` | :heavy_check_mark: | Log probability of the token | -| `Token` | `string` | :heavy_check_mark: | The token | -| `TopLogprobs` | [][components.ChatTokenLogprobTopLogprob](../../models/components/chattokenlogprobtoplogprob.mdx) | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file +| `Bytes` | []`int64` | ✅ | UTF-8 bytes of the token | +| `Logprob` | `float64` | ✅ | Log probability of the token | +| `Token` | `string` | ✅ | The token | +| `TopLogprobs` | [][components.ChatTokenLogprobTopLogprob](../../models/components/chattokenlogprobtoplogprob.mdx) | ✅ | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/docs/models/components/chattokenlogprobs.mdx b/docs/models/components/chattokenlogprobs.mdx index 067f0fcdf..8b95880dd 100644 --- a/docs/models/components/chattokenlogprobs.mdx +++ b/docs/models/components/chattokenlogprobs.mdx @@ -9,5 +9,5 @@ Log probabilities for the completion | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx) | :heavy_check_mark: | Log probabilities for content tokens | -| `Refusal` | optionalnullable.OptionalNullable[[][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx)] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file +| `Content` | [][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx) | ✅ | Log probabilities for content tokens | +| `Refusal` | optionalnullable.OptionalNullable[[][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx)] | ➖ | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/docs/models/components/chattokenlogprobtoplogprob.mdx b/docs/models/components/chattokenlogprobtoplogprob.mdx index a7c9c4b81..79e3e4198 100644 --- a/docs/models/components/chattokenlogprobtoplogprob.mdx +++ b/docs/models/components/chattokenlogprobtoplogprob.mdx @@ -6,6 +6,6 @@ title: "ChatTokenLogprobTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ✅ | N/A | +| `Logprob` | `float64` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chattoolcall.mdx b/docs/models/components/chattoolcall.mdx index 61d059663..607124b9f 100644 --- a/docs/models/components/chattoolcall.mdx +++ b/docs/models/components/chattoolcall.mdx @@ -9,6 +9,6 @@ Tool call made by the assistant | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Function` | [components.ChatToolCallFunction](../../models/components/chattoolcallfunction.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | Tool call identifier | -| `Type` | [components.ChatToolCallType](../../models/components/chattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Function` | [components.ChatToolCallFunction](../../models/components/chattoolcallfunction.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | Tool call identifier | +| `Type` | [components.ChatToolCallType](../../models/components/chattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/chattoolcallfunction.mdx b/docs/models/components/chattoolcallfunction.mdx index 908931f3b..2314523ed 100644 --- a/docs/models/components/chattoolcallfunction.mdx +++ b/docs/models/components/chattoolcallfunction.mdx @@ -6,5 +6,5 @@ title: "ChatToolCallFunction" | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | Function arguments as JSON string | -| `Name` | `string` | :heavy_check_mark: | Function name to call | \ No newline at end of file +| `Arguments` | `string` | ✅ | Function arguments as JSON string | +| `Name` | `string` | ✅ | Function name to call | \ No newline at end of file diff --git a/docs/models/components/chattoolmessage.mdx b/docs/models/components/chattoolmessage.mdx index 894285e3b..8375711db 100644 --- a/docs/models/components/chattoolmessage.mdx +++ b/docs/models/components/chattoolmessage.mdx @@ -9,6 +9,6 @@ Tool response message | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Content` | [components.ChatToolMessageContent](../../models/components/chattoolmessagecontent.mdx) | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `Role` | [components.ChatToolMessageRole](../../models/components/chattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `ToolCallID` | `string` | :heavy_check_mark: | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file +| `Content` | [components.ChatToolMessageContent](../../models/components/chattoolmessagecontent.mdx) | ✅ | Tool response content | The weather in San Francisco is 72°F and sunny. | +| `Role` | [components.ChatToolMessageRole](../../models/components/chattoolmessagerole.mdx) | ✅ | N/A | | +| `ToolCallID` | `string` | ✅ | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file diff --git a/docs/models/components/chatusage.mdx b/docs/models/components/chatusage.mdx index 691f7b23d..6331c2b91 100644 --- a/docs/models/components/chatusage.mdx +++ b/docs/models/components/chatusage.mdx @@ -9,12 +9,12 @@ Token usage statistics | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `CompletionTokens` | `int64` | :heavy_check_mark: | Number of tokens in the completion | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsageCompletionTokensDetails](../../models/components/chatusagecompletiontokensdetails.mdx)] | :heavy_minus_sign: | Detailed completion token usage | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `PromptTokens` | `int64` | :heavy_check_mark: | Number of tokens in the prompt | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsagePromptTokensDetails](../../models/components/chatusageprompttokensdetails.mdx)] | :heavy_minus_sign: | Detailed prompt token usage | | -| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | -| `TotalTokens` | `int64` | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file +| `CompletionTokens` | `int64` | ✅ | Number of tokens in the completion | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsageCompletionTokensDetails](../../models/components/chatusagecompletiontokensdetails.mdx)] | ➖ | Detailed completion token usage | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `PromptTokens` | `int64` | ✅ | Number of tokens in the prompt | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsagePromptTokensDetails](../../models/components/chatusageprompttokensdetails.mdx)] | ➖ | Detailed prompt token usage | | +| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | +| `TotalTokens` | `int64` | ✅ | Total number of tokens | | \ No newline at end of file diff --git a/docs/models/components/chatusagecompletiontokensdetails.mdx b/docs/models/components/chatusagecompletiontokensdetails.mdx index f657f3448..e824b194b 100644 --- a/docs/models/components/chatusagecompletiontokensdetails.mdx +++ b/docs/models/components/chatusagecompletiontokensdetails.mdx @@ -9,7 +9,7 @@ Detailed completion token usage | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `AcceptedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Accepted prediction tokens | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for audio output | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for reasoning | -| `RejectedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Rejected prediction tokens | \ No newline at end of file +| `AcceptedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Accepted prediction tokens | +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for audio output | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for reasoning | +| `RejectedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Rejected prediction tokens | \ No newline at end of file diff --git a/docs/models/components/chatusageprompttokensdetails.mdx b/docs/models/components/chatusageprompttokensdetails.mdx index 4810cf7d8..566f2663f 100644 --- a/docs/models/components/chatusageprompttokensdetails.mdx +++ b/docs/models/components/chatusageprompttokensdetails.mdx @@ -9,7 +9,7 @@ Detailed prompt token usage | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | `*int64` | :heavy_minus_sign: | Audio input tokens | -| `CacheWriteTokens` | `*int64` | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | `*int64` | :heavy_minus_sign: | Cached prompt tokens | -| `VideoTokens` | `*int64` | :heavy_minus_sign: | Video input tokens | \ No newline at end of file +| `AudioTokens` | `*int64` | ➖ | Audio input tokens | +| `CacheWriteTokens` | `*int64` | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | `*int64` | ➖ | Cached prompt tokens | +| `VideoTokens` | `*int64` | ➖ | Video input tokens | \ No newline at end of file diff --git a/docs/models/components/chatusermessage.mdx b/docs/models/components/chatusermessage.mdx index d1bf5ce4f..07d61f471 100644 --- a/docs/models/components/chatusermessage.mdx +++ b/docs/models/components/chatusermessage.mdx @@ -9,6 +9,6 @@ User message | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Content` | [components.ChatUserMessageContent](../../models/components/chatusermessagecontent.mdx) | :heavy_check_mark: | User message content | What is the capital of France? | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for the user | User | -| `Role` | [components.ChatUserMessageRole](../../models/components/chatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [components.ChatUserMessageContent](../../models/components/chatusermessagecontent.mdx) | ✅ | User message content | What is the capital of France? | +| `Name` | `*string` | ➖ | Optional name for the user | User | +| `Role` | [components.ChatUserMessageRole](../../models/components/chatusermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatwebsearchshorthand.mdx b/docs/models/components/chatwebsearchshorthand.mdx index 57c7dd399..3f0216fb2 100644 --- a/docs/models/components/chatwebsearchshorthand.mdx +++ b/docs/models/components/chatwebsearchshorthand.mdx @@ -9,16 +9,16 @@ Web search tool using OpenAI Responses API syntax. Automatically converted to op | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `MaxCharacters` | `*int64` | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxTotalResults` | `*int64` | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `Type` | [components.ChatWebSearchShorthandType](../../models/components/chatwebsearchshorthandtype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `AllowedDomains` | []`string` | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `ExcludedDomains` | []`string` | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `MaxCharacters` | `*int64` | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxTotalResults` | `*int64` | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `Type` | [components.ChatWebSearchShorthandType](../../models/components/chatwebsearchshorthandtype.mdx) | ✅ | N/A | | +| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/choice.mdx b/docs/models/components/choice.mdx index 2c57c13fb..369d0e9db 100644 --- a/docs/models/components/choice.mdx +++ b/docs/models/components/choice.mdx @@ -6,8 +6,8 @@ title: "Choice" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `FinishReason` | [components.FinishReason](../../models/components/finishreason.mdx) | :heavy_check_mark: | N/A | stop | -| `Index` | `int64` | :heavy_check_mark: | N/A | | -| `Logprobs` | [*components.Logprobs](../../models/components/logprobs.mdx) | :heavy_check_mark: | N/A | | -| `Message` | [components.Message](../../models/components/message.mdx) | :heavy_check_mark: | N/A | | -| `NativeFinishReason` | `*string` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `FinishReason` | [components.FinishReason](../../models/components/finishreason.mdx) | ✅ | N/A | stop | +| `Index` | `int64` | ✅ | N/A | | +| `Logprobs` | [*components.Logprobs](../../models/components/logprobs.mdx) | ✅ | N/A | | +| `Message` | [components.Message](../../models/components/message.mdx) | ✅ | N/A | | +| `NativeFinishReason` | `*string` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallcodedeltaevent.mdx b/docs/models/components/codeinterpretercallcodedeltaevent.mdx index cacd126e1..9384cd531 100644 --- a/docs/models/components/codeinterpretercallcodedeltaevent.mdx +++ b/docs/models/components/codeinterpretercallcodedeltaevent.mdx @@ -9,8 +9,8 @@ Incremental chunk of code being streamed for a `code_interpreter_call`. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CodeInterpreterCallCodeDeltaEventType](../../models/components/codeinterpretercallcodedeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.CodeInterpreterCallCodeDeltaEventType](../../models/components/codeinterpretercallcodedeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallcodedoneevent.mdx b/docs/models/components/codeinterpretercallcodedoneevent.mdx index 2881a462d..9ab93243c 100644 --- a/docs/models/components/codeinterpretercallcodedoneevent.mdx +++ b/docs/models/components/codeinterpretercallcodedoneevent.mdx @@ -9,8 +9,8 @@ Emitted when code streaming completes for a `code_interpreter_call`. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Code` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CodeInterpreterCallCodeDoneEventType](../../models/components/codeinterpretercallcodedoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Code` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.CodeInterpreterCallCodeDoneEventType](../../models/components/codeinterpretercallcodedoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallcompletedevent.mdx b/docs/models/components/codeinterpretercallcompletedevent.mdx index 2f1bd1d44..ffacec43f 100644 --- a/docs/models/components/codeinterpretercallcompletedevent.mdx +++ b/docs/models/components/codeinterpretercallcompletedevent.mdx @@ -9,7 +9,7 @@ Code interpreter call completed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CodeInterpreterCallCompletedEventType](../../models/components/codeinterpretercallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.CodeInterpreterCallCompletedEventType](../../models/components/codeinterpretercallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallinprogressevent.mdx b/docs/models/components/codeinterpretercallinprogressevent.mdx index 17e85cf0e..e4cdb0941 100644 --- a/docs/models/components/codeinterpretercallinprogressevent.mdx +++ b/docs/models/components/codeinterpretercallinprogressevent.mdx @@ -9,7 +9,7 @@ Code interpreter call in progress | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CodeInterpreterCallInProgressEventType](../../models/components/codeinterpretercallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.CodeInterpreterCallInProgressEventType](../../models/components/codeinterpretercallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpretercallinterpretingevent.mdx b/docs/models/components/codeinterpretercallinterpretingevent.mdx index 90f2aae8e..b6413c2ab 100644 --- a/docs/models/components/codeinterpretercallinterpretingevent.mdx +++ b/docs/models/components/codeinterpretercallinterpretingevent.mdx @@ -9,7 +9,7 @@ Code interpreter is executing the code | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CodeInterpreterCallInterpretingEventType](../../models/components/codeinterpretercallinterpretingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.CodeInterpreterCallInterpretingEventType](../../models/components/codeinterpretercallinterpretingeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterfileoutput.mdx b/docs/models/components/codeinterpreterfileoutput.mdx index 2ab8eb84c..b54069840 100644 --- a/docs/models/components/codeinterpreterfileoutput.mdx +++ b/docs/models/components/codeinterpreterfileoutput.mdx @@ -6,13 +6,13 @@ title: "CodeInterpreterFileOutput" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DownloadURL` | `*string` | :heavy_minus_sign: | Provider-issued download URL for the generated file. Typically signed and time-limited (see `expires_at`); fetch promptly rather than persisting the URL. | -| `ErrorCode` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Provider error code when generating or persisting the file failed; null or absent on success. | -| `ExpiresAt` | `*string` | :heavy_minus_sign: | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | -| `Filename` | `*string` | :heavy_minus_sign: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `MediaType` | `*string` | :heavy_minus_sign: | N/A | -| `Sha256` | `*string` | :heavy_minus_sign: | N/A | -| `SizeBytes` | `*int64` | :heavy_minus_sign: | N/A | -| `Status` | `*string` | :heavy_minus_sign: | Provider-reported readiness of the generated file (e.g. `ready`). Values other than `ready` indicate the artifact may not be downloadable. | -| `Type` | [components.CodeInterpreterFileOutputType](../../models/components/codeinterpreterfileoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `DownloadURL` | `*string` | ➖ | Provider-issued download URL for the generated file. Typically signed and time-limited (see `expires_at`); fetch promptly rather than persisting the URL. | +| `ErrorCode` | optionalnullable.OptionalNullable[`string`] | ➖ | Provider error code when generating or persisting the file failed; null or absent on success. | +| `ExpiresAt` | `*string` | ➖ | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | +| `Filename` | `*string` | ➖ | N/A | +| `ID` | `*string` | ➖ | N/A | +| `MediaType` | `*string` | ➖ | N/A | +| `Sha256` | `*string` | ➖ | N/A | +| `SizeBytes` | `*int64` | ➖ | N/A | +| `Status` | `*string` | ➖ | Provider-reported readiness of the generated file (e.g. `ready`). Values other than `ready` indicate the artifact may not be downloadable. | +| `Type` | [components.CodeInterpreterFileOutputType](../../models/components/codeinterpreterfileoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterimageoutput.mdx b/docs/models/components/codeinterpreterimageoutput.mdx index e84a5d592..b1f17b735 100644 --- a/docs/models/components/codeinterpreterimageoutput.mdx +++ b/docs/models/components/codeinterpreterimageoutput.mdx @@ -6,5 +6,5 @@ title: "CodeInterpreterImageOutput" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Type` | [components.CodeInterpreterImageOutputType](../../models/components/codeinterpreterimageoutputtype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CodeInterpreterImageOutputType](../../models/components/codeinterpreterimageoutputtype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterlogsoutput.mdx b/docs/models/components/codeinterpreterlogsoutput.mdx index a4c4d46a7..7e8ae461d 100644 --- a/docs/models/components/codeinterpreterlogsoutput.mdx +++ b/docs/models/components/codeinterpreterlogsoutput.mdx @@ -6,5 +6,5 @@ title: "CodeInterpreterLogsOutput" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Logs` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.CodeInterpreterLogsOutputType](../../models/components/codeinterpreterlogsoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Logs` | `string` | ✅ | N/A | +| `Type` | [components.CodeInterpreterLogsOutputType](../../models/components/codeinterpreterlogsoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterservertool.mdx b/docs/models/components/codeinterpreterservertool.mdx index 9a8544350..d07484c5a 100644 --- a/docs/models/components/codeinterpreterservertool.mdx +++ b/docs/models/components/codeinterpreterservertool.mdx @@ -9,5 +9,5 @@ Code interpreter tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Container` | [components.Container](../../models/components/container.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.TypeCodeInterpreter](../../models/components/typecodeinterpreter.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Container` | [components.Container](../../models/components/container.mdx) | ✅ | N/A | +| `Type` | [components.TypeCodeInterpreter](../../models/components/typecodeinterpreter.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/codexlocalshelltool.mdx b/docs/models/components/codexlocalshelltool.mdx index 7f7725af8..f9424cc21 100644 --- a/docs/models/components/codexlocalshelltool.mdx +++ b/docs/models/components/codexlocalshelltool.mdx @@ -9,4 +9,4 @@ Local shell tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Type` | [components.CodexLocalShellToolType](../../models/components/codexlocalshelltooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CodexLocalShellToolType](../../models/components/codexlocalshelltooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/compactionitem.mdx b/docs/models/components/compactionitem.mdx index b7b846c91..5d360e8aa 100644 --- a/docs/models/components/compactionitem.mdx +++ b/docs/models/components/compactionitem.mdx @@ -9,7 +9,7 @@ A context compaction marker with encrypted summary | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.CompactionItemType](../../models/components/compactionitemtype.mdx) | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file +| `EncryptedContent` | `string` | ✅ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Type` | [components.CompactionItemType](../../models/components/compactionitemtype.mdx) | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file diff --git a/docs/models/components/compoundfilter.mdx b/docs/models/components/compoundfilter.mdx index 7fbf1362d..bfe89847d 100644 --- a/docs/models/components/compoundfilter.mdx +++ b/docs/models/components/compoundfilter.mdx @@ -9,5 +9,5 @@ A compound filter that combines multiple comparison or compound filters | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Filters` | []map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.CompoundFilterType](../../models/components/compoundfiltertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Filters` | []map[string]`any` | ✅ | N/A | +| `Type` | [components.CompoundFilterType](../../models/components/compoundfiltertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/computeruseservertool.mdx b/docs/models/components/computeruseservertool.mdx index 33b8f8fc3..e9c4e08b1 100644 --- a/docs/models/components/computeruseservertool.mdx +++ b/docs/models/components/computeruseservertool.mdx @@ -9,7 +9,7 @@ Computer use preview tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `DisplayHeight` | `int64` | :heavy_check_mark: | N/A | -| `DisplayWidth` | `int64` | :heavy_check_mark: | N/A | -| `Environment` | [components.Environment](../../models/components/environment.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ComputerUseServerToolType](../../models/components/computeruseservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `DisplayHeight` | `int64` | ✅ | N/A | +| `DisplayWidth` | `int64` | ✅ | N/A | +| `Environment` | [components.Environment](../../models/components/environment.mdx) | ✅ | N/A | +| `Type` | [components.ComputerUseServerToolType](../../models/components/computeruseservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/configurationupdateitem.mdx b/docs/models/components/configurationupdateitem.mdx index 7c2ce6e55..a40c7d52f 100644 --- a/docs/models/components/configurationupdateitem.mdx +++ b/docs/models/components/configurationupdateitem.mdx @@ -9,6 +9,6 @@ Changes reasoning effort from this point in the conversation onward without inva | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | -| `Type` | [components.ConfigurationUpdateItemType](../../models/components/configurationupdateitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Reasoning` | [components.ConfigurationUpdateReasoning](../../models/components/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | +| `Type` | [components.ConfigurationUpdateItemType](../../models/components/configurationupdateitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/configurationupdatereasoning.mdx b/docs/models/components/configurationupdatereasoning.mdx index a13d2a858..8c57d0c95 100644 --- a/docs/models/components/configurationupdatereasoning.mdx +++ b/docs/models/components/configurationupdatereasoning.mdx @@ -9,4 +9,4 @@ Reasoning settings applied from this point in the conversation onward | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Effort` | [components.ConfigurationUpdateReasoningEffort](../../models/components/configurationupdatereasoningeffort.mdx) | :heavy_check_mark: | Reasoning effort to apply from this point in the conversation onward | low | \ No newline at end of file +| `Effort` | [components.ConfigurationUpdateReasoningEffort](../../models/components/configurationupdatereasoningeffort.mdx) | ✅ | Reasoning effort to apply from this point in the conversation onward | low | \ No newline at end of file diff --git a/docs/models/components/conflictresponseerrordata.mdx b/docs/models/components/conflictresponseerrordata.mdx index f7a2d6ffd..bcffefd90 100644 --- a/docs/models/components/conflictresponseerrordata.mdx +++ b/docs/models/components/conflictresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ConflictResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/containerauto.mdx b/docs/models/components/containerauto.mdx index f0a61aa66..28ec54494 100644 --- a/docs/models/components/containerauto.mdx +++ b/docs/models/components/containerauto.mdx @@ -6,6 +6,6 @@ title: "ContainerAuto" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `FileIds` | []`string` | :heavy_minus_sign: | N/A | -| `MemoryLimit` | optionalnullable.OptionalNullable[[components.MemoryLimit](../../models/components/memorylimit.mdx)] | :heavy_minus_sign: | N/A | -| `Type` | [components.ContainerType](../../models/components/containertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileIds` | []`string` | ➖ | N/A | +| `MemoryLimit` | optionalnullable.OptionalNullable[[components.MemoryLimit](../../models/components/memorylimit.mdx)] | ➖ | N/A | +| `Type` | [components.ContainerType](../../models/components/containertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/containerautoenvironment.mdx b/docs/models/components/containerautoenvironment.mdx index 0c022b727..3d7abff5e 100644 --- a/docs/models/components/containerautoenvironment.mdx +++ b/docs/models/components/containerautoenvironment.mdx @@ -9,6 +9,6 @@ An OpenRouter-managed, auto-provisioned ephemeral container. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `FileIds` | []`string` | :heavy_minus_sign: | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | -| `NetworkPolicy` | [*components.ContainerNetworkPolicy](../../models/components/containernetworkpolicy.mdx) | :heavy_minus_sign: | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | -| `Type` | [components.ContainerAutoEnvironmentType](../../models/components/containerautoenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `FileIds` | []`string` | ➖ | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | +| `NetworkPolicy` | [*components.ContainerNetworkPolicy](../../models/components/containernetworkpolicy.mdx) | ➖ | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | +| `Type` | [components.ContainerAutoEnvironmentType](../../models/components/containerautoenvironmenttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/containerfile.mdx b/docs/models/components/containerfile.mdx index 26ec73eda..882b5794e 100644 --- a/docs/models/components/containerfile.mdx +++ b/docs/models/components/containerfile.mdx @@ -6,10 +6,10 @@ title: "ContainerFile" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `Bytes` | `int64` | :heavy_check_mark: | File size in bytes. | 123 | -| `ContainerID` | `string` | :heavy_check_mark: | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | -| `CreatedAt` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) when the file was last synced. | 1755640000 | -| `ID` | `string` | :heavy_check_mark: | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `Object` | [components.ContainerFileObject](../../models/components/containerfileobject.mdx) | :heavy_check_mark: | N/A | container.file | -| `Path` | `string` | :heavy_check_mark: | Container-relative file path. | out/report.csv | -| `Source` | [components.ContainerFileSource](../../models/components/containerfilesource.mdx) | :heavy_check_mark: | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file +| `Bytes` | `int64` | ✅ | File size in bytes. | 123 | +| `ContainerID` | `string` | ✅ | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | +| `CreatedAt` | `int64` | ✅ | Unix timestamp (seconds) when the file was last synced. | 1755640000 | +| `ID` | `string` | ✅ | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `Object` | [components.ContainerFileObject](../../models/components/containerfileobject.mdx) | ✅ | N/A | container.file | +| `Path` | `string` | ✅ | Container-relative file path. | out/report.csv | +| `Source` | [components.ContainerFileSource](../../models/components/containerfilesource.mdx) | ✅ | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file diff --git a/docs/models/components/containerfilelistresponse.mdx b/docs/models/components/containerfilelistresponse.mdx index 6269ff622..06759ba1c 100644 --- a/docs/models/components/containerfilelistresponse.mdx +++ b/docs/models/components/containerfilelistresponse.mdx @@ -6,8 +6,8 @@ title: "ContainerFileListResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.ContainerFile](../../models/components/containerfile.mdx) | :heavy_check_mark: | N/A | | -| `FirstID` | `*string` | :heavy_check_mark: | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | -| `HasMore` | `bool` | :heavy_check_mark: | True when another page can be fetched by passing `after=last_id`; `last_id` is non-null whenever this is true. | false | -| `LastID` | `*string` | :heavy_check_mark: | Cursor for the next page (pass as `after`). The last entry’s id, except when the page stopped at the per-request scan bound on hidden bookkeeping objects: then it names the scan position and may not appear in `data`. Null only when `has_more` is false and `data` is empty. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `Object` | [components.ContainerFileListResponseObject](../../models/components/containerfilelistresponseobject.mdx) | :heavy_check_mark: | N/A | list | \ No newline at end of file +| `Data` | [][components.ContainerFile](../../models/components/containerfile.mdx) | ✅ | N/A | | +| `FirstID` | `*string` | ✅ | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | +| `HasMore` | `bool` | ✅ | True when another page can be fetched by passing `after=last_id`; `last_id` is non-null whenever this is true. | false | +| `LastID` | `*string` | ✅ | Cursor for the next page (pass as `after`). The last entry’s id, except when the page stopped at the per-request scan bound on hidden bookkeeping objects: then it names the scan position and may not appear in `data`. Null only when `has_more` is false and `data` is empty. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `Object` | [components.ContainerFileListResponseObject](../../models/components/containerfilelistresponseobject.mdx) | ✅ | N/A | list | \ No newline at end of file diff --git a/docs/models/components/containernetworkpolicyallowlist.mdx b/docs/models/components/containernetworkpolicyallowlist.mdx index 66a74b43b..405cb8462 100644 --- a/docs/models/components/containernetworkpolicyallowlist.mdx +++ b/docs/models/components/containernetworkpolicyallowlist.mdx @@ -6,5 +6,5 @@ title: "ContainerNetworkPolicyAllowlist" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedDomains` | []`string` | :heavy_check_mark: | Hostnames the container may reach over ports 80/443 (max 50). Entries are lowercase hostnames or glob patterns where * matches any run of characters (e.g. *.example.com). An exact hostname does not cover its subdomains — use a glob or list each hostname. pip needs both pypi.org and files.pythonhosted.org (or *.pythonhosted.org). | [
"pypi.org",
"files.pythonhosted.org"
] | -| `Type` | [components.TypeAllowlist](../../models/components/typeallowlist.mdx) | :heavy_check_mark: | Outbound access restricted to the listed domains. | | \ No newline at end of file +| `AllowedDomains` | []`string` | ✅ | Hostnames the container may reach over ports 80/443 (max 50). Entries are lowercase hostnames or glob patterns where * matches any run of characters (e.g. *.example.com). An exact hostname does not cover its subdomains — use a glob or list each hostname. pip needs both pypi.org and files.pythonhosted.org (or *.pythonhosted.org). | [
"pypi.org",
"files.pythonhosted.org"
] | +| `Type` | [components.TypeAllowlist](../../models/components/typeallowlist.mdx) | ✅ | Outbound access restricted to the listed domains. | | \ No newline at end of file diff --git a/docs/models/components/containernetworkpolicydisabled.mdx b/docs/models/components/containernetworkpolicydisabled.mdx index 85be85d3b..12c57f2f4 100644 --- a/docs/models/components/containernetworkpolicydisabled.mdx +++ b/docs/models/components/containernetworkpolicydisabled.mdx @@ -6,4 +6,4 @@ title: "ContainerNetworkPolicyDisabled" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.ContainerNetworkPolicyTypeDisabled](../../models/components/containernetworkpolicytypedisabled.mdx) | :heavy_check_mark: | No outbound internet access. | \ No newline at end of file +| `Type` | [components.ContainerNetworkPolicyTypeDisabled](../../models/components/containernetworkpolicytypedisabled.mdx) | ✅ | No outbound internet access. | \ No newline at end of file diff --git a/docs/models/components/containerreferenceenvironment.mdx b/docs/models/components/containerreferenceenvironment.mdx index 7be53eeb9..1ab47d38e 100644 --- a/docs/models/components/containerreferenceenvironment.mdx +++ b/docs/models/components/containerreferenceenvironment.mdx @@ -9,7 +9,7 @@ Reference to a container by its canonical id — a previously returned container | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | Canonical container id to reuse (max 40 characters, letters/digits/underscores/hyphens). Any container_id previously returned by a bash or shell tool result works here and reattaches to the same container and files — including session-derived ids (sess_...) and generation-derived ids (gen_...). Note that a session-derived id is always sess_ + the sanitized session key, which is not necessarily the raw session id you sent. Using the same container_id from both the bash and shell tools shares the same files, with last-write-wins when both flush concurrently. A fresh name creates a new persistent container. Containers are always scoped to your account and workspace. | sess_abc123 | -| `FileIds` | []`string` | :heavy_minus_sign: | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | -| `NetworkPolicy` | [*components.ContainerNetworkPolicy](../../models/components/containernetworkpolicy.mdx) | :heavy_minus_sign: | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | -| `Type` | [components.ContainerReferenceEnvironmentType](../../models/components/containerreferenceenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ContainerID` | `string` | ✅ | Canonical container id to reuse (max 40 characters, letters/digits/underscores/hyphens). Any container_id previously returned by a bash or shell tool result works here and reattaches to the same container and files — including session-derived ids (sess_...) and generation-derived ids (gen_...). Note that a session-derived id is always sess_ + the sanitized session key, which is not necessarily the raw session id you sent. Using the same container_id from both the bash and shell tools shares the same files, with last-write-wins when both flush concurrently. A fresh name creates a new persistent container. Containers are always scoped to your account and workspace. | sess_abc123 | +| `FileIds` | []`string` | ➖ | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | +| `NetworkPolicy` | [*components.ContainerNetworkPolicy](../../models/components/containernetworkpolicy.mdx) | ➖ | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | +| `Type` | [components.ContainerReferenceEnvironmentType](../../models/components/containerreferenceenvironmenttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentcompaction.mdx b/docs/models/components/contentcompaction.mdx index c29bc3322..5fec86138 100644 --- a/docs/models/components/contentcompaction.mdx +++ b/docs/models/components/contentcompaction.mdx @@ -6,7 +6,7 @@ title: "ContentCompaction" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Content` | `*string` | :heavy_check_mark: | N/A | | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.MessagesMessageParamTypeCompaction](../../models/components/messagesmessageparamtypecompaction.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Content` | `*string` | ✅ | N/A | | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Type` | [components.MessagesMessageParamTypeCompaction](../../models/components/messagesmessageparamtypecompaction.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentencryptedcontent.mdx b/docs/models/components/contentencryptedcontent.mdx index ddd84c8e7..90b387d63 100644 --- a/docs/models/components/contentencryptedcontent.mdx +++ b/docs/models/components/contentencryptedcontent.mdx @@ -6,6 +6,6 @@ title: "ContentEncryptedContent" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeEncryptedContent](../../models/components/typeencryptedcontent.mdx) | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `EncryptedContent` | `string` | ✅ | N/A | +| `Type` | [components.TypeEncryptedContent](../../models/components/typeencryptedcontent.mdx) | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentfilterbuiltinentry.mdx b/docs/models/components/contentfilterbuiltinentry.mdx index 36e3d28de..fe2e1e5d4 100644 --- a/docs/models/components/contentfilterbuiltinentry.mdx +++ b/docs/models/components/contentfilterbuiltinentry.mdx @@ -9,7 +9,7 @@ A builtin content filter entry. Builtin filters include PII detectors, API-key a | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | -| `Label` | `*string` | :heavy_minus_sign: | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | -| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope.mdx) | :heavy_minus_sign: | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | -| `Slug` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | +| `Label` | `*string` | ➖ | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | +| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope.mdx) | ➖ | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | +| `Slug` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/components/contentfilterbuiltinentryinput.mdx b/docs/models/components/contentfilterbuiltinentryinput.mdx index 5a92789b3..e48650c9c 100644 --- a/docs/models/components/contentfilterbuiltinentryinput.mdx +++ b/docs/models/components/contentfilterbuiltinentryinput.mdx @@ -9,7 +9,7 @@ A builtin content filter entry for create/update requests. Labels are system-ass | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | -| ~~`Label`~~ | `*string` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: labels are system-assigned and cannot be set by the caller. Accepted for backward compatibility but silently ignored. | | -| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope.mdx) | :heavy_minus_sign: | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | -| `Slug` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | +| ~~`Label`~~ | `*string` | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: labels are system-assigned and cannot be set by the caller. Accepted for backward compatibility but silently ignored. | | +| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope.mdx) | ➖ | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | +| `Slug` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/components/contentfilterentry.mdx b/docs/models/components/contentfilterentry.mdx index b48bd98f8..bad791ebf 100644 --- a/docs/models/components/contentfilterentry.mdx +++ b/docs/models/components/contentfilterentry.mdx @@ -9,6 +9,6 @@ A custom regex content filter that scans request messages for matching patterns. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterAction](../../models/components/contentfilteraction.mdx) | :heavy_check_mark: | Action taken when the pattern matches | block | -| `Label` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional label used in redaction placeholders or error messages | [API_KEY] | -| `Pattern` | `string` | :heavy_check_mark: | A regex pattern to match against request content | \b(sk-[a-zA-Z0-9]\{48})\b | \ No newline at end of file +| `Action` | [components.ContentFilterAction](../../models/components/contentfilteraction.mdx) | ✅ | Action taken when the pattern matches | block | +| `Label` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional label used in redaction placeholders or error messages | [API_KEY] | +| `Pattern` | `string` | ✅ | A regex pattern to match against request content | \b(sk-[a-zA-Z0-9]\{48})\b | \ No newline at end of file diff --git a/docs/models/components/contentimageurl.mdx b/docs/models/components/contentimageurl.mdx index dd326660a..9dfeb1b04 100644 --- a/docs/models/components/contentimageurl.mdx +++ b/docs/models/components/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ImageURL` | [components.ContentImageURLImageURL](../../models/components/contentimageurlimageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.FileTypeImageURL](../../models/components/filetypeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.ContentImageURLImageURL](../../models/components/contentimageurlimageurl.mdx) | ✅ | N/A | +| `Type` | [components.FileTypeImageURL](../../models/components/filetypeimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentimageurlimageurl.mdx b/docs/models/components/contentimageurlimageurl.mdx index 1328a98d5..09954e882 100644 --- a/docs/models/components/contentimageurlimageurl.mdx +++ b/docs/models/components/contentimageurlimageurl.mdx @@ -6,4 +6,4 @@ title: "ContentImageURLImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartaddedevent.mdx b/docs/models/components/contentpartaddedevent.mdx index 0ff8554c9..88a75e880 100644 --- a/docs/models/components/contentpartaddedevent.mdx +++ b/docs/models/components/contentpartaddedevent.mdx @@ -9,9 +9,9 @@ Event emitted when a new content part is added to an output item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `Part` | [components.ContentPartAddedEventPart](../../models/components/contentpartaddedeventpart.mdx) | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartAddedEventType](../../models/components/contentpartaddedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `Part` | [components.ContentPartAddedEventPart](../../models/components/contentpartaddedeventpart.mdx) | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ContentPartAddedEventType](../../models/components/contentpartaddedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartaudio.mdx b/docs/models/components/contentpartaudio.mdx index caf675127..36f5ccf4a 100644 --- a/docs/models/components/contentpartaudio.mdx +++ b/docs/models/components/contentpartaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartAudio" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `AudioURL` | [components.AudioURL](../../models/components/audiourl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartAudioType](../../models/components/contentpartaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `AudioURL` | [components.AudioURL](../../models/components/audiourl.mdx) | ✅ | N/A | +| `Type` | [components.ContentPartAudioType](../../models/components/contentpartaudiotype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartdoneevent.mdx b/docs/models/components/contentpartdoneevent.mdx index 864566ba6..9d3854394 100644 --- a/docs/models/components/contentpartdoneevent.mdx +++ b/docs/models/components/contentpartdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when a content part is complete | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `Part` | [components.ContentPartDoneEventPart](../../models/components/contentpartdoneeventpart.mdx) | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartDoneEventType](../../models/components/contentpartdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `Part` | [components.ContentPartDoneEventPart](../../models/components/contentpartdoneeventpart.mdx) | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ContentPartDoneEventType](../../models/components/contentpartdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartimage.mdx b/docs/models/components/contentpartimage.mdx index 38f6d6a38..d12776a64 100644 --- a/docs/models/components/contentpartimage.mdx +++ b/docs/models/components/contentpartimage.mdx @@ -6,5 +6,5 @@ title: "ContentPartImage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ContentPartImageImageURL](../../models/components/contentpartimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartImageType](../../models/components/contentpartimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.ContentPartImageImageURL](../../models/components/contentpartimageimageurl.mdx) | ✅ | N/A | +| `Type` | [components.ContentPartImageType](../../models/components/contentpartimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartimageimageurl.mdx b/docs/models/components/contentpartimageimageurl.mdx index cb2bb88a3..28dc58406 100644 --- a/docs/models/components/contentpartimageimageurl.mdx +++ b/docs/models/components/contentpartimageimageurl.mdx @@ -6,4 +6,4 @@ title: "ContentPartImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartinputaudio.mdx b/docs/models/components/contentpartinputaudio.mdx index 3a57ab34d..16c0346ad 100644 --- a/docs/models/components/contentpartinputaudio.mdx +++ b/docs/models/components/contentpartinputaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputAudio" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputAudioType](../../models/components/contentpartinputaudiotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `InputAudio` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputAudioType](../../models/components/contentpartinputaudiotype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartinputfile.mdx b/docs/models/components/contentpartinputfile.mdx index 53966b872..2da178d04 100644 --- a/docs/models/components/contentpartinputfile.mdx +++ b/docs/models/components/contentpartinputfile.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputFile" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `InputFile` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputFileType](../../models/components/contentpartinputfiletype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `InputFile` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputFileType](../../models/components/contentpartinputfiletype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartinputvideo.mdx b/docs/models/components/contentpartinputvideo.mdx index 8e03b7472..8c102fab1 100644 --- a/docs/models/components/contentpartinputvideo.mdx +++ b/docs/models/components/contentpartinputvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputVideo" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `InputVideo` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputVideoType](../../models/components/contentpartinputvideotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `InputVideo` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputVideoType](../../models/components/contentpartinputvideotype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartvideo.mdx b/docs/models/components/contentpartvideo.mdx index 42e9a7d29..5973f9b52 100644 --- a/docs/models/components/contentpartvideo.mdx +++ b/docs/models/components/contentpartvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartVideo" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.ContentPartVideoType](../../models/components/contentpartvideotype.mdx) | :heavy_check_mark: | N/A | -| `VideoURL` | [components.VideoURL](../../models/components/videourl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ContentPartVideoType](../../models/components/contentpartvideotype.mdx) | ✅ | N/A | +| `VideoURL` | [components.VideoURL](../../models/components/videourl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentredactedthinking.mdx b/docs/models/components/contentredactedthinking.mdx index 018f5cbd7..e755ede21 100644 --- a/docs/models/components/contentredactedthinking.mdx +++ b/docs/models/components/contentredactedthinking.mdx @@ -6,5 +6,5 @@ title: "ContentRedactedThinking" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesMessageParamTypeRedactedThinking](../../models/components/messagesmessageparamtyperedactedthinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | `string` | ✅ | N/A | +| `Type` | [components.MessagesMessageParamTypeRedactedThinking](../../models/components/messagesmessageparamtyperedactedthinking.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentservertooluse.mdx b/docs/models/components/contentservertooluse.mdx index dc706284e..e868c05f1 100644 --- a/docs/models/components/contentservertooluse.mdx +++ b/docs/models/components/contentservertooluse.mdx @@ -6,8 +6,8 @@ title: "ContentServerToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Input` | `any` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.MessagesMessageParamTypeServerToolUse](../../models/components/messagesmessageparamtypeservertooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `ID` | `string` | ✅ | N/A | | +| `Input` | `any` | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Type` | [components.MessagesMessageParamTypeServerToolUse](../../models/components/messagesmessageparamtypeservertooluse.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contenttext.mdx b/docs/models/components/contenttext.mdx index e92d1c327..4e3541eb2 100644 --- a/docs/models/components/contenttext.mdx +++ b/docs/models/components/contenttext.mdx @@ -6,5 +6,5 @@ title: "ContentText" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.BatchObjectFileTypeText](../../models/components/batchobjectfiletypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.BatchObjectFileTypeText](../../models/components/batchobjectfiletypetext.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentthinking.mdx b/docs/models/components/contentthinking.mdx index 625af8ff2..5fe1f0bce 100644 --- a/docs/models/components/contentthinking.mdx +++ b/docs/models/components/contentthinking.mdx @@ -6,6 +6,6 @@ title: "ContentThinking" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Signature` | `string` | :heavy_check_mark: | N/A | -| `Thinking` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesMessageParamTypeThinking](../../models/components/messagesmessageparamtypethinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Signature` | `string` | ✅ | N/A | +| `Thinking` | `string` | ✅ | N/A | +| `Type` | [components.MessagesMessageParamTypeThinking](../../models/components/messagesmessageparamtypethinking.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contenttoolreference.mdx b/docs/models/components/contenttoolreference.mdx index cee24863d..7a2d5a419 100644 --- a/docs/models/components/contenttoolreference.mdx +++ b/docs/models/components/contenttoolreference.mdx @@ -6,5 +6,5 @@ title: "ContentToolReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ToolName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesMessageParamTypeToolReference](../../models/components/messagesmessageparamtypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ToolName` | `string` | ✅ | N/A | +| `Type` | [components.MessagesMessageParamTypeToolReference](../../models/components/messagesmessageparamtypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contenttoolresult.mdx b/docs/models/components/contenttoolresult.mdx index 13241baa3..e539309d3 100644 --- a/docs/models/components/contenttoolresult.mdx +++ b/docs/models/components/contenttoolresult.mdx @@ -6,8 +6,8 @@ title: "ContentToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Content` | [*components.MessagesMessageParamContentUnion2](../../models/components/messagesmessageparamcontentunion2.mdx) | :heavy_minus_sign: | N/A | | -| `IsError` | `*bool` | :heavy_minus_sign: | N/A | | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeToolResult](../../models/components/typetoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Content` | [*components.MessagesMessageParamContentUnion2](../../models/components/messagesmessageparamcontentunion2.mdx) | ➖ | N/A | | +| `IsError` | `*bool` | ➖ | N/A | | +| `ToolUseID` | `string` | ✅ | N/A | | +| `Type` | [components.TypeToolResult](../../models/components/typetoolresult.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contenttooluse.mdx b/docs/models/components/contenttooluse.mdx index 5432648fe..c76cc9875 100644 --- a/docs/models/components/contenttooluse.mdx +++ b/docs/models/components/contenttooluse.mdx @@ -6,8 +6,8 @@ title: "ContentToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Input` | `any` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.MessagesMessageParamTypeToolUse](../../models/components/messagesmessageparamtypetooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `ID` | `string` | ✅ | N/A | | +| `Input` | `any` | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Type` | [components.MessagesMessageParamTypeToolUse](../../models/components/messagesmessageparamtypetooluse.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contenttoplogprob.mdx b/docs/models/components/contenttoplogprob.mdx index 6b398df96..b27301c52 100644 --- a/docs/models/components/contenttoplogprob.mdx +++ b/docs/models/components/contenttoplogprob.mdx @@ -6,6 +6,6 @@ title: "ContentTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ✅ | N/A | +| `Logprob` | `float64` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contentwebsearchtoolresult.mdx b/docs/models/components/contentwebsearchtoolresult.mdx index cc9a9c07f..0ac434b95 100644 --- a/docs/models/components/contentwebsearchtoolresult.mdx +++ b/docs/models/components/contentwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "ContentWebSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Content` | [components.MessagesMessageParamContentUnion3](../../models/components/messagesmessageparamcontentunion3.mdx) | :heavy_check_mark: | N/A | | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.MessagesMessageParamTypeWebSearchToolResult](../../models/components/messagesmessageparamtypewebsearchtoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Content` | [components.MessagesMessageParamContentUnion3](../../models/components/messagesmessageparamcontentunion3.mdx) | ✅ | N/A | | +| `ToolUseID` | `string` | ✅ | N/A | | +| `Type` | [components.MessagesMessageParamTypeWebSearchToolResult](../../models/components/messagesmessageparamtypewebsearchtoolresult.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentwebsearchtoolresulterror.mdx b/docs/models/components/contentwebsearchtoolresulterror.mdx index 0c7fb33ee..fc52f1423 100644 --- a/docs/models/components/contentwebsearchtoolresulterror.mdx +++ b/docs/models/components/contentwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "ContentWebSearchToolResultError" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `ErrorCode` | [components.MessagesMessageParamErrorCode](../../models/components/messagesmessageparamerrorcode.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesMessageParamTypeWebSearchToolResultError](../../models/components/messagesmessageparamtypewebsearchtoolresulterror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ErrorCode` | [components.MessagesMessageParamErrorCode](../../models/components/messagesmessageparamerrorcode.mdx) | ✅ | N/A | +| `Type` | [components.MessagesMessageParamTypeWebSearchToolResultError](../../models/components/messagesmessageparamtypewebsearchtoolresulterror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/contextcompactionitem.mdx b/docs/models/components/contextcompactionitem.mdx index 8ac1ee1ca..b5ee4936f 100644 --- a/docs/models/components/contextcompactionitem.mdx +++ b/docs/models/components/contextcompactionitem.mdx @@ -9,7 +9,7 @@ A context compaction marker with an optional encrypted summary | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.ContextCompactionItemType](../../models/components/contextcompactionitemtype.mdx) | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Type` | [components.ContextCompactionItemType](../../models/components/contextcompactionitemtype.mdx) | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file diff --git a/docs/models/components/contextcompressionplugin.mdx b/docs/models/components/contextcompressionplugin.mdx index 50c79da24..c51fa60fd 100644 --- a/docs/models/components/contextcompressionplugin.mdx +++ b/docs/models/components/contextcompressionplugin.mdx @@ -6,6 +6,6 @@ title: "ContextCompressionPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `Engine` | [*components.ContextCompressionEngine](../../models/components/contextcompressionengine.mdx) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | -| `ID` | [components.ContextCompressionPluginID](../../models/components/contextcompressionpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | Set to false to disable the context-compression plugin for this request. Defaults to true. | | +| `Engine` | [*components.ContextCompressionEngine](../../models/components/contextcompressionengine.mdx) | ➖ | The compression engine to use. Defaults to "middle-out". | middle-out | +| `ID` | [components.ContextCompressionPluginID](../../models/components/contextcompressionpluginid.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/contextmanagement.mdx b/docs/models/components/contextmanagement.mdx index be2538c0e..b6fa7bcbe 100644 --- a/docs/models/components/contextmanagement.mdx +++ b/docs/models/components/contextmanagement.mdx @@ -6,4 +6,4 @@ title: "ContextManagement" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `Edits` | [][components.Edit](../../models/components/edit.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Edits` | [][components.Edit](../../models/components/edit.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/contradiction.mdx b/docs/models/components/contradiction.mdx index eff1167cf..70f03571a 100644 --- a/docs/models/components/contradiction.mdx +++ b/docs/models/components/contradiction.mdx @@ -6,5 +6,5 @@ title: "Contradiction" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Stances` | [][components.Stance](../../models/components/stance.mdx) | :heavy_check_mark: | N/A | -| `Topic` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Stances` | [][components.Stance](../../models/components/stance.mdx) | ✅ | N/A | +| `Topic` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/costdetails.mdx b/docs/models/components/costdetails.mdx index 3fc74c6e1..f1e37a790 100644 --- a/docs/models/components/costdetails.mdx +++ b/docs/models/components/costdetails.mdx @@ -9,7 +9,7 @@ Breakdown of upstream inference costs | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ServerToolCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | -| `UpstreamInferenceCompletionsCost` | `float64` | :heavy_check_mark: | N/A | -| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `UpstreamInferencePromptCost` | `float64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `ServerToolCost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | +| `UpstreamInferenceCompletionsCost` | `float64` | ✅ | N/A | +| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | +| `UpstreamInferencePromptCost` | `float64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/createbyokkeyrequest.mdx b/docs/models/components/createbyokkeyrequest.mdx index 5e93353b2..218a40e6c 100644 --- a/docs/models/components/createbyokkeyrequest.mdx +++ b/docs/models/components/createbyokkeyrequest.mdx @@ -6,16 +6,16 @@ title: "CreateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedAPIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.CreateBYOKKeyRequestDeclaredRegion](../../models/components/createbyokkeyrequestdeclaredregion.mdx)] | :heavy_minus_sign: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. | null | -| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Defaults to `null`. | null | -| `Disabled` | `*bool` | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | -| `IsBYOKOnly` | `*bool` | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Defaults to `false`. | false | -| `IsFallback` | `*bool` | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | -| `IsRequired` | `*bool` | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Defaults to `false`. | false | -| `Key` | `string` | :heavy_check_mark: | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | -| `Name` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to scope the credential to. When omitted, the credential is created in the account's default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `AllowedAPIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.CreateBYOKKeyRequestDeclaredRegion](../../models/components/createbyokkeyrequestdeclaredregion.mdx)] | ➖ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. | null | +| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Defaults to `null`. | null | +| `Disabled` | `*bool` | ➖ | Whether this credential should be created in a disabled state. | false | +| `IsBYOKOnly` | `*bool` | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Defaults to `false`. | false | +| `IsFallback` | `*bool` | ➖ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | +| `IsRequired` | `*bool` | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Defaults to `false`. | false | +| `Key` | `string` | ✅ | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | +| `Name` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | +| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `WorkspaceID` | `*string` | ➖ | Optional workspace ID to scope the credential to. When omitted, the credential is created in the account's default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/createbyokkeyresponse.mdx b/docs/models/components/createbyokkeyresponse.mdx index c0e18d9d9..5f9e0ba2d 100644 --- a/docs/models/components/createbyokkeyresponse.mdx +++ b/docs/models/components/createbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "CreateBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/createenduserrequest.mdx b/docs/models/components/createenduserrequest.mdx index 695800505..9f70a6e70 100644 --- a/docs/models/components/createenduserrequest.mdx +++ b/docs/models/components/createenduserrequest.mdx @@ -6,4 +6,4 @@ title: "CreateEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file +| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file diff --git a/docs/models/components/createguardrailrequest.mdx b/docs/models/components/createguardrailrequest.mdx index a66d2aa1f..20144c856 100644 --- a/docs/models/components/createguardrailrequest.mdx +++ b/docs/models/components/createguardrailrequest.mdx @@ -6,25 +6,25 @@ title: "CreateGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput.mdx)] | :heavy_minus_sign: | Builtin content filters to apply. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | -| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Defaults to false. | false | -| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Spending limit in USD. Must be provided together with `reset_interval`: a request that sets only one of the two is rejected with a 400. | 50 | -| `Name` | `string` | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | The workspace to create the guardrail in. When omitted, the guardrail is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. This only places the guardrail in the workspace; the created guardrail enforces nothing for that workspace's traffic until it is assigned to API keys or members. To restrict all traffic in a workspace, update the workspace's default guardrail instead. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput.mdx)] | ➖ | Builtin content filters to apply. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | +| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | ➖ | Custom regex content filters to apply to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | Description of the guardrail | A guardrail for limiting API usage | +| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | +| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Defaults to false. | false | +| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | ➖ | Spending limit in USD. Must be provided together with `reset_interval`: a request that sets only one of the two is rejected with a 400. | 50 | +| `Name` | `string` | ✅ | Name for the new guardrail | My New Guardrail | +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `WorkspaceID` | `*string` | ➖ | The workspace to create the guardrail in. When omitted, the guardrail is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. This only places the guardrail in the workspace; the created guardrail enforces nothing for that workspace's traffic until it is assigned to API keys or members. To restrict all traffic in a workspace, update the workspace's default guardrail instead. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/components/createguardrailresponse.mdx b/docs/models/components/createguardrailresponse.mdx index 0c0484aff..813b35f37 100644 --- a/docs/models/components/createguardrailresponse.mdx +++ b/docs/models/components/createguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "CreateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/components/createinternrequest.mdx b/docs/models/components/createinternrequest.mdx index 77788102a..18c787ed4 100644 --- a/docs/models/components/createinternrequest.mdx +++ b/docs/models/components/createinternrequest.mdx @@ -9,9 +9,9 @@ Settings for a new intern. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Free-form description, or null. | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Standing instructions the intern boots with, or null. | -| `Name` | `string` | :heavy_check_mark: | Intern name, unique per creator within the workspace. | -| `Provision` | `*bool` | :heavy_minus_sign: | Start provisioning during this create operation. Defaults to false. | -| `VaultID` | `*string` | :heavy_minus_sign: | Vault owned by another intern in this workspace to attach as a borrowed vault. | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace that will own the intern. Defaults to the workspace the API key resolves to. When given, it must match the API key workspace. | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | Free-form description, or null. | +| `Instructions` | optionalnullable.OptionalNullable[`string`] | ➖ | Standing instructions the intern boots with, or null. | +| `Name` | `string` | ✅ | Intern name, unique per creator within the workspace. | +| `Provision` | `*bool` | ➖ | Start provisioning during this create operation. Defaults to false. | +| `VaultID` | `*string` | ➖ | Vault owned by another intern in this workspace to attach as a borrowed vault. | +| `WorkspaceID` | `*string` | ➖ | Workspace that will own the intern. Defaults to the workspace the API key resolves to. When given, it must match the API key workspace. | \ No newline at end of file diff --git a/docs/models/components/createobservabilitydestinationrequest.mdx b/docs/models/components/createobservabilitydestinationrequest.mdx index c91f0d16d..5b08cfdfd 100644 --- a/docs/models/components/createobservabilitydestinationrequest.mdx +++ b/docs/models/components/createobservabilitydestinationrequest.mdx @@ -6,16 +6,16 @@ title: "CreateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided. | null | -| `BroadcastGenerationCost` | `*bool` | :heavy_minus_sign: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `*bool` | :heavy_minus_sign: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `*bool` | :heavy_minus_sign: | When true, include request-context generation metadata. | false | -| `Config` | map[string]`any` | :heavy_check_mark: | Provider-specific configuration. The shape depends on `type` and is validated server-side. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | -| `Enabled` | `*bool` | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | -| `Name` | `string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `*bool` | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegionInput](../../models/components/observabilitydataregioninput.mdx) | :heavy_minus_sign: | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field defaults to ['global']; the array must be non-empty. | [
"global"
] | -| `SamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.CreateObservabilityDestinationRequestType](../../models/components/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided. | null | +| `BroadcastGenerationCost` | `*bool` | ➖ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `*bool` | ➖ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `*bool` | ➖ | When true, include request-context generation metadata. | false | +| `Config` | map[string]`any` | ✅ | Provider-specific configuration. The shape depends on `type` and is validated server-side. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | +| `Enabled` | `*bool` | ➖ | Whether this destination should be enabled immediately. | true | +| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | ➖ | Optional structured filter rules controlling which events are forwarded. | null | +| `Name` | `string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `*bool` | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegionInput](../../models/components/observabilitydataregioninput.mdx) | ➖ | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field defaults to ['global']; the array must be non-empty. | [
"global"
] | +| `SamplingRate` | `*float64` | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.CreateObservabilityDestinationRequestType](../../models/components/createobservabilitydestinationrequesttype.mdx) | ✅ | The destination type. Only stable destination types are accepted. | langfuse | +| `WorkspaceID` | `*string` | ➖ | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/createobservabilitydestinationresponse.mdx b/docs/models/components/createobservabilitydestinationresponse.mdx index a54ab81b9..61fd51956 100644 --- a/docs/models/components/createobservabilitydestinationresponse.mdx +++ b/docs/models/components/createobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "CreateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/createpresetfrominferenceresponse.mdx b/docs/models/components/createpresetfrominferenceresponse.mdx index 1dc095a80..765b9e6ec 100644 --- a/docs/models/components/createpresetfrominferenceresponse.mdx +++ b/docs/models/components/createpresetfrominferenceresponse.mdx @@ -9,4 +9,4 @@ Response containing the created preset with its designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion.mdx) | :heavy_check_mark: | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file +| `Data` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion.mdx) | ✅ | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file diff --git a/docs/models/components/createprivateendpointrequest.mdx b/docs/models/components/createprivateendpointrequest.mdx index e99c53a17..c76cce7fd 100644 --- a/docs/models/components/createprivateendpointrequest.mdx +++ b/docs/models/components/createprivateendpointrequest.mdx @@ -6,11 +6,11 @@ title: "CreatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Activate` | [*components.PrivateEndpointActivation](../../models/components/privateendpointactivation.mdx) | :heavy_minus_sign: | Validate and activate in the same call. On a failed validation the draft is kept and returned with a 422, so fix it and call `/validate` and `/activate` instead of creating it again. | \{
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `BaseURL` | `*string` | :heavy_minus_sign: | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.CreatePrivateEndpointRequestDeclaredRegion](../../models/components/createprivateendpointrequestdeclaredregion.mdx)] | :heavy_minus_sign: | Attest where this deployment processes data. | us | -| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `Pricing` | [*components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | :heavy_minus_sign: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `ProviderSlug` | `string` | :heavy_check_mark: | Slug of the upstream provider. | azure | -| `UpstreamModelID` | `string` | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `Activate` | [*components.PrivateEndpointActivation](../../models/components/privateendpointactivation.mdx) | ➖ | Validate and activate in the same call. On a failed validation the draft is kept and returned with a 422, so fix it and call `/validate` and `/activate` instead of creating it again. | \{
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `BaseURL` | `*string` | ➖ | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.CreatePrivateEndpointRequestDeclaredRegion](../../models/components/createprivateendpointrequestdeclaredregion.mdx)] | ➖ | Attest where this deployment processes data. | us | +| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Attest that this deployment retains no prompt or completion data. | | +| `ModelPermaslug` | `string` | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `Pricing` | [*components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | ➖ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `ProviderSlug` | `string` | ✅ | Slug of the upstream provider. | azure | +| `UpstreamModelID` | `string` | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/components/createprivateendpointvalidationfailedresponsedata.mdx b/docs/models/components/createprivateendpointvalidationfailedresponsedata.mdx index 852b33b91..62ebef42b 100644 --- a/docs/models/components/createprivateendpointvalidationfailedresponsedata.mdx +++ b/docs/models/components/createprivateendpointvalidationfailedresponsedata.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseData" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Endpoint` | [components.ManagedPrivateEndpoint](../../models/components/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | -| `Validation` | [*components.PrivateEndpointValidationNullable](../../models/components/privateendpointvalidationnullable.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Endpoint` | [components.ManagedPrivateEndpoint](../../models/components/managedprivateendpoint.mdx) | ✅ | N/A | +| `Validation` | [*components.PrivateEndpointValidationNullable](../../models/components/privateendpointvalidationnullable.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/createprivateendpointvalidationfailedresponseerror.mdx b/docs/models/components/createprivateendpointvalidationfailedresponseerror.mdx index 8c723288f..ea13a95ac 100644 --- a/docs/models/components/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/models/components/createprivateendpointvalidationfailedresponseerror.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseError" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/createscimgroupmappingrequest.mdx b/docs/models/components/createscimgroupmappingrequest.mdx index 42cb64559..bf680f52f 100644 --- a/docs/models/components/createscimgroupmappingrequest.mdx +++ b/docs/models/components/createscimgroupmappingrequest.mdx @@ -6,6 +6,6 @@ title: "CreateScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Role` | [components.CreateScimGroupMappingRequestRole](../../models/components/createscimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | -| `ScimGroupID` | `string` | :heavy_check_mark: | N/A | -| `WorkspaceID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Role` | [components.CreateScimGroupMappingRequestRole](../../models/components/createscimgroupmappingrequestrole.mdx) | ✅ | N/A | +| `ScimGroupID` | `string` | ✅ | N/A | +| `WorkspaceID` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/createscimgroupmappingresponse.mdx b/docs/models/components/createscimgroupmappingresponse.mdx index 9440c95d4..61334a1ee 100644 --- a/docs/models/components/createscimgroupmappingresponse.mdx +++ b/docs/models/components/createscimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "CreateScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/createscimsyncjobresponse.mdx b/docs/models/components/createscimsyncjobresponse.mdx index 81504d827..5dd0e6f6d 100644 --- a/docs/models/components/createscimsyncjobresponse.mdx +++ b/docs/models/components/createscimsyncjobresponse.mdx @@ -6,4 +6,4 @@ title: "CreateScimSyncJobResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Data` | [components.ScimSyncJob](../../models/components/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.ScimSyncJob](../../models/components/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/createworkspacerequest.mdx b/docs/models/components/createworkspacerequest.mdx index 36a87f5b6..4238549a3 100644 --- a/docs/models/components/createworkspacerequest.mdx +++ b/docs/models/components/createworkspacerequest.mdx @@ -6,15 +6,15 @@ title: "CreateWorkspaceRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the workspace | Production environment workspace | -| `DisabledServerTools` | optionalnullable.OptionalNullable[[][components.CreateWorkspaceRequestDisabledServerTool](../../models/components/createworkspacerequestdisabledservertool.mdx)] | :heavy_minus_sign: | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | -| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | -| `IoLoggingSamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `IsDataDiscountLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `IsObservabilityBroadcastEnabled` | `*bool` | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `IsObservabilityIoLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether private logging is enabled | false | -| `Name` | `string` | :heavy_check_mark: | Name for the new workspace | Production | -| `Slug` | `string` | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file +| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Default image model for this workspace | openai/dall-e-3 | +| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Default text model for this workspace | openai/gpt-4o | +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | Description of the workspace | Production environment workspace | +| `DisabledServerTools` | optionalnullable.OptionalNullable[[][components.CreateWorkspaceRequestDisabledServerTool](../../models/components/createworkspacerequestdisabledservertool.mdx)] | ➖ | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | +| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | ➖ | Optional array of API key IDs to filter I/O logging | null | +| `IoLoggingSamplingRate` | `*float64` | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | +| `IsDataDiscountLoggingEnabled` | `*bool` | ➖ | Whether data discount logging is enabled | true | +| `IsObservabilityBroadcastEnabled` | `*bool` | ➖ | Whether broadcast is enabled | false | +| `IsObservabilityIoLoggingEnabled` | `*bool` | ➖ | Whether private logging is enabled | false | +| `Name` | `string` | ✅ | Name for the new workspace | Production | +| `Slug` | `string` | ✅ | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file diff --git a/docs/models/components/createworkspaceresponse.mdx b/docs/models/components/createworkspaceresponse.mdx index 390c1ae20..8806285c0 100644 --- a/docs/models/components/createworkspaceresponse.mdx +++ b/docs/models/components/createworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "CreateWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `Data` | [components.Workspace](../../models/components/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/components/customtool.mdx b/docs/models/components/customtool.mdx index e8bf8dc67..78ac9400e 100644 --- a/docs/models/components/customtool.mdx +++ b/docs/models/components/customtool.mdx @@ -9,8 +9,8 @@ Custom tool configuration | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `Description` | `*string` | :heavy_minus_sign: | N/A | | -| `Format` | [*components.Format](../../models/components/format.mdx) | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.CustomToolTypeCustom](../../models/components/customtooltypecustom.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `Description` | `*string` | ➖ | N/A | | +| `Format` | [*components.Format](../../models/components/format.mdx) | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Type` | [components.CustomToolTypeCustom](../../models/components/customtooltypecustom.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/customtoolcallinputdeltaevent.mdx b/docs/models/components/customtoolcallinputdeltaevent.mdx index 487e53971..1e60870dd 100644 --- a/docs/models/components/customtoolcallinputdeltaevent.mdx +++ b/docs/models/components/customtoolcallinputdeltaevent.mdx @@ -9,8 +9,8 @@ Event emitted when a custom tool call's freeform input is being streamed. Mirror | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolCallInputDeltaEventType](../../models/components/customtoolcallinputdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.CustomToolCallInputDeltaEventType](../../models/components/customtoolcallinputdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcallinputdoneevent.mdx b/docs/models/components/customtoolcallinputdoneevent.mdx index dac6d4d87..8d359288a 100644 --- a/docs/models/components/customtoolcallinputdoneevent.mdx +++ b/docs/models/components/customtoolcallinputdoneevent.mdx @@ -9,8 +9,8 @@ Event emitted when a custom tool call's freeform input streaming is complete. Mi | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Input` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolCallInputDoneEventType](../../models/components/customtoolcallinputdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Input` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.CustomToolCallInputDoneEventType](../../models/components/customtoolcallinputdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcallitem.mdx b/docs/models/components/customtoolcallitem.mdx index c67b023fb..d612becd2 100644 --- a/docs/models/components/customtoolcallitem.mdx +++ b/docs/models/components/customtoolcallitem.mdx @@ -9,11 +9,11 @@ A call to a custom (freeform-grammar) tool created by the model — distinct fro | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Async` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Input` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.CustomToolCallItemType](../../models/components/customtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Async` | optionalnullable.OptionalNullable[`bool`] | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Input` | `string` | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Namespace` | optionalnullable.OptionalNullable[`string`] | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | +| `Type` | [components.CustomToolCallItemType](../../models/components/customtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/customtoolcalloutputitem.mdx b/docs/models/components/customtoolcalloutputitem.mdx index 7ec0b9d38..10f36104e 100644 --- a/docs/models/components/customtoolcalloutputitem.mdx +++ b/docs/models/components/customtoolcalloutputitem.mdx @@ -9,7 +9,7 @@ The output from a custom (freeform-grammar) tool call execution. Mirrors `functi | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Output` | [components.CustomToolCallOutputItemOutputUnion2](../../models/components/customtoolcalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../../models/components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | +| `ID` | `*string` | ➖ | N/A | +| `Output` | [components.CustomToolCallOutputItemOutputUnion2](../../models/components/customtoolcalloutputitemoutputunion2.mdx) | ✅ | N/A | +| `Type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../../models/components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx b/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx index 4055f686d..9e8c8427c 100644 --- a/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx +++ b/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Detail` | [components.CustomToolCallOutputItemDetail](../../models/components/customtoolcalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.CustomToolCallOutputItemOutputType](../../models/components/customtoolcalloutputitemoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Detail` | [components.CustomToolCallOutputItemDetail](../../models/components/customtoolcalloutputitemdetail.mdx) | ✅ | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.CustomToolCallOutputItemOutputType](../../models/components/customtoolcalloutputitemoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/dabenchmarkentry.mdx b/docs/models/components/dabenchmarkentry.mdx index c95852f49..f99928c48 100644 --- a/docs/models/components/dabenchmarkentry.mdx +++ b/docs/models/components/dabenchmarkentry.mdx @@ -9,8 +9,8 @@ A single Design Arena benchmark entry for a specific arena+category | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Arena` | `string` | :heavy_check_mark: | Arena type (e.g. models, builders, agents) | models | -| `Category` | `string` | :heavy_check_mark: | Category within the arena (e.g. website, gamedev, uicomponent) | website | -| `Elo` | `float64` | :heavy_check_mark: | ELO rating from head-to-head arena battles | 1385.2 | -| `Rank` | `int64` | :heavy_check_mark: | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | -| `WinRate` | `float64` | :heavy_check_mark: | Win rate percentage in arena battles | 62.5 | \ No newline at end of file +| `Arena` | `string` | ✅ | Arena type (e.g. models, builders, agents) | models | +| `Category` | `string` | ✅ | Category within the arena (e.g. website, gamedev, uicomponent) | website | +| `Elo` | `float64` | ✅ | ELO rating from head-to-head arena battles | 1385.2 | +| `Rank` | `int64` | ✅ | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | +| `WinRate` | `float64` | ✅ | Win rate percentage in arena battles | 62.5 | \ No newline at end of file diff --git a/docs/models/components/datetimeservertool.mdx b/docs/models/components/datetimeservertool.mdx index 221fe0940..8e2ab49cd 100644 --- a/docs/models/components/datetimeservertool.mdx +++ b/docs/models/components/datetimeservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: returns the current date and time | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.DatetimeServerToolConfig](../../models/components/datetimeservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | -| `Type` | [components.DatetimeServerToolType](../../models/components/datetimeservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.DatetimeServerToolConfig](../../models/components/datetimeservertoolconfig.mdx) | ➖ | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | +| `Type` | [components.DatetimeServerToolType](../../models/components/datetimeservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/datetimeservertoolconfig.mdx b/docs/models/components/datetimeservertoolconfig.mdx index afcc032a2..aa411f8fd 100644 --- a/docs/models/components/datetimeservertoolconfig.mdx +++ b/docs/models/components/datetimeservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:datetime server tool | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Timezone` | `*string` | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file +| `Timezone` | `*string` | ➖ | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file diff --git a/docs/models/components/debugevent.mdx b/docs/models/components/debugevent.mdx index e2ceb694d..95ed0a23e 100644 --- a/docs/models/components/debugevent.mdx +++ b/docs/models/components/debugevent.mdx @@ -9,6 +9,6 @@ Debug event emitted when debug.echo_upstream_body is true. Contains the transfor | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Debug` | [components.DebugEventDebug](../../models/components/debugeventdebug.mdx) | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.DebugEventType](../../models/components/debugeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Debug` | [components.DebugEventDebug](../../models/components/debugeventdebug.mdx) | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.DebugEventType](../../models/components/debugeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/debugeventdebug.mdx b/docs/models/components/debugeventdebug.mdx index 9df19ec9a..1ad9be38d 100644 --- a/docs/models/components/debugeventdebug.mdx +++ b/docs/models/components/debugeventdebug.mdx @@ -6,5 +6,5 @@ title: "DebugEventDebug" | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `EchoUpstreamBody` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Timings` | [*components.DebugEventTimings](../../models/components/debugeventtimings.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `EchoUpstreamBody` | map[string]`any` | ➖ | N/A | +| `Timings` | [*components.DebugEventTimings](../../models/components/debugeventtimings.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/debugeventtimings.mdx b/docs/models/components/debugeventtimings.mdx index c925054ae..6dddd22b8 100644 --- a/docs/models/components/debugeventtimings.mdx +++ b/docs/models/components/debugeventtimings.mdx @@ -6,6 +6,6 @@ title: "DebugEventTimings" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `EpochMs` | `int64` | :heavy_check_mark: | N/A | -| `Event` | [components.DebugEventEvent](../../models/components/debugeventevent.mdx) | :heavy_check_mark: | N/A | -| `StartMs` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `EpochMs` | `int64` | ✅ | N/A | +| `Event` | [components.DebugEventEvent](../../models/components/debugeventevent.mdx) | ✅ | N/A | +| `StartMs` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/decisions.mdx b/docs/models/components/decisions.mdx index 72fd4efa3..93156b90f 100644 --- a/docs/models/components/decisions.mdx +++ b/docs/models/components/decisions.mdx @@ -6,6 +6,6 @@ title: "Decisions" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/decisionschoiceanswer.mdx b/docs/models/components/decisionschoiceanswer.mdx index 0b8964ab3..cb067ff54 100644 --- a/docs/models/components/decisionschoiceanswer.mdx +++ b/docs/models/components/decisionschoiceanswer.mdx @@ -6,7 +6,7 @@ title: "DecisionsChoiceAnswer" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Choice` | `string` | :heavy_check_mark: | N/A | -| `Confidence` | `*float64` | :heavy_minus_sign: | N/A | -| `Probabilities` | map[string]`float64` | :heavy_minus_sign: | N/A | -| `Type` | [components.DecisionsChoiceAnswerType](../../models/components/decisionschoiceanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Choice` | `string` | ✅ | N/A | +| `Confidence` | `*float64` | ➖ | N/A | +| `Probabilities` | map[string]`float64` | ➖ | N/A | +| `Type` | [components.DecisionsChoiceAnswerType](../../models/components/decisionschoiceanswertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionschoicequestion.mdx b/docs/models/components/decisionschoicequestion.mdx index cd83cdf6c..c894f9bf4 100644 --- a/docs/models/components/decisionschoicequestion.mdx +++ b/docs/models/components/decisionschoicequestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsChoiceQuestion" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Criteria` | map[string][*components.Criteria](../../models/components/criteria.mdx) | :heavy_check_mark: | N/A | -| `Instructions` | [components.DecisionsChoiceQuestionInstructions](../../models/components/decisionschoicequestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `Type` | [components.DecisionsChoiceQuestionType](../../models/components/decisionschoicequestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Criteria` | map[string][*components.Criteria](../../models/components/criteria.mdx) | ✅ | N/A | +| `Instructions` | [components.DecisionsChoiceQuestionInstructions](../../models/components/decisionschoicequestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `Type` | [components.DecisionsChoiceQuestionType](../../models/components/decisionschoicequestiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsnoulanswer.mdx b/docs/models/components/decisionsnoulanswer.mdx index 3aea0c5c2..d644c3709 100644 --- a/docs/models/components/decisionsnoulanswer.mdx +++ b/docs/models/components/decisionsnoulanswer.mdx @@ -6,5 +6,5 @@ title: "DecisionsNoulAnswer" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Noul` | `float64` | :heavy_check_mark: | N/A | -| `Type` | [components.DecisionsNoulAnswerType](../../models/components/decisionsnoulanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Noul` | `float64` | ✅ | N/A | +| `Type` | [components.DecisionsNoulAnswerType](../../models/components/decisionsnoulanswertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsnoulquestion.mdx b/docs/models/components/decisionsnoulquestion.mdx index 3566d9cc5..fcaafca54 100644 --- a/docs/models/components/decisionsnoulquestion.mdx +++ b/docs/models/components/decisionsnoulquestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsNoulQuestion" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Criteria` | [*components.DecisionsNoulQuestionCriteria](../../models/components/decisionsnoulquestioncriteria.mdx) | :heavy_minus_sign: | N/A | -| `Instructions` | [components.DecisionsNoulQuestionInstructions](../../models/components/decisionsnoulquestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `Type` | [components.DecisionsNoulQuestionType](../../models/components/decisionsnoulquestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Criteria` | [*components.DecisionsNoulQuestionCriteria](../../models/components/decisionsnoulquestioncriteria.mdx) | ➖ | N/A | +| `Instructions` | [components.DecisionsNoulQuestionInstructions](../../models/components/decisionsnoulquestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `Type` | [components.DecisionsNoulQuestionType](../../models/components/decisionsnoulquestiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsnoulquestioncriteria.mdx b/docs/models/components/decisionsnoulquestioncriteria.mdx index 891e8365b..e479d8a28 100644 --- a/docs/models/components/decisionsnoulquestioncriteria.mdx +++ b/docs/models/components/decisionsnoulquestioncriteria.mdx @@ -6,5 +6,5 @@ title: "DecisionsNoulQuestionCriteria" | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `False` | [components.False](../../models/components/false.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `True` | [components.True](../../models/components/true.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file +| `False` | [components.False](../../models/components/false.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `True` | [components.True](../../models/components/true.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file diff --git a/docs/models/components/decisionsrequest.mdx b/docs/models/components/decisionsrequest.mdx index eb2788da9..c24687c92 100644 --- a/docs/models/components/decisionsrequest.mdx +++ b/docs/models/components/decisionsrequest.mdx @@ -6,10 +6,10 @@ title: "DecisionsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `Questions` | map[string][components.Questions](../../models/components/questions.mdx) | :heavy_check_mark: | N/A | | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `State` | [components.State](../../models/components/state.mdx) | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Model` | `string` | ✅ | N/A | | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `Questions` | map[string][components.Questions](../../models/components/questions.mdx) | ✅ | N/A | | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `State` | [components.State](../../models/components/state.mdx) | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/decisionsresponse.mdx b/docs/models/components/decisionsresponse.mdx index 56c0634a1..1c8031767 100644 --- a/docs/models/components/decisionsresponse.mdx +++ b/docs/models/components/decisionsresponse.mdx @@ -6,8 +6,8 @@ title: "DecisionsResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Answers` | map[string][components.Answers](../../models/components/answers.mdx) | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Provider` | `*string` | :heavy_minus_sign: | N/A | -| `Usage` | [components.DecisionsResponseUsage](../../models/components/decisionsresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Answers` | map[string][components.Answers](../../models/components/answers.mdx) | ✅ | N/A | +| `ID` | `*string` | ➖ | N/A | +| `Model` | `string` | ✅ | N/A | +| `Provider` | `*string` | ➖ | N/A | +| `Usage` | [components.DecisionsResponseUsage](../../models/components/decisionsresponseusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsresponseusage.mdx b/docs/models/components/decisionsresponseusage.mdx index c5f773737..1a9779095 100644 --- a/docs/models/components/decisionsresponseusage.mdx +++ b/docs/models/components/decisionsresponseusage.mdx @@ -6,6 +6,6 @@ title: "DecisionsResponseUsage" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Cost` | `*float64` | :heavy_minus_sign: | N/A | -| `InputTokens` | `int64` | :heavy_check_mark: | N/A | -| `OutputTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Cost` | `*float64` | ➖ | N/A | +| `InputTokens` | `int64` | ✅ | N/A | +| `OutputTokens` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsscoreanswer.mdx b/docs/models/components/decisionsscoreanswer.mdx index b99f15142..dc4337ab7 100644 --- a/docs/models/components/decisionsscoreanswer.mdx +++ b/docs/models/components/decisionsscoreanswer.mdx @@ -6,8 +6,8 @@ title: "DecisionsScoreAnswer" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Confidence` | `*float64` | :heavy_minus_sign: | N/A | -| `Legend` | map[string][components.Legend](../../models/components/legend.mdx) | :heavy_minus_sign: | N/A | -| `Probabilities` | map[string]`float64` | :heavy_minus_sign: | N/A | -| `Score` | `float64` | :heavy_check_mark: | N/A | -| `Type` | [components.DecisionsScoreAnswerType](../../models/components/decisionsscoreanswertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Confidence` | `*float64` | ➖ | N/A | +| `Legend` | map[string][components.Legend](../../models/components/legend.mdx) | ➖ | N/A | +| `Probabilities` | map[string]`float64` | ➖ | N/A | +| `Score` | `float64` | ✅ | N/A | +| `Type` | [components.DecisionsScoreAnswerType](../../models/components/decisionsscoreanswertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/decisionsscorequestion.mdx b/docs/models/components/decisionsscorequestion.mdx index 327538fd2..92d2c0227 100644 --- a/docs/models/components/decisionsscorequestion.mdx +++ b/docs/models/components/decisionsscorequestion.mdx @@ -6,6 +6,6 @@ title: "DecisionsScoreQuestion" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Criteria` | [][components.Criterion](../../models/components/criterion.mdx) | :heavy_check_mark: | N/A | -| `Instructions` | [components.DecisionsScoreQuestionInstructions](../../models/components/decisionsscorequestioninstructions.mdx) | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `Type` | [components.DecisionsScoreQuestionType](../../models/components/decisionsscorequestiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Criteria` | [][components.Criterion](../../models/components/criterion.mdx) | ✅ | N/A | +| `Instructions` | [components.DecisionsScoreQuestionInstructions](../../models/components/decisionsscorequestioninstructions.mdx) | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `Type` | [components.DecisionsScoreQuestionType](../../models/components/decisionsscorequestiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/defaultparameters.mdx b/docs/models/components/defaultparameters.mdx index e6ddbdebf..97cbacfaa 100644 --- a/docs/models/components/defaultparameters.mdx +++ b/docs/models/components/defaultparameters.mdx @@ -9,9 +9,9 @@ Default parameters for this model | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `TopK` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | +| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | +| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | +| `Temperature` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | +| `TopK` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | +| `TopP` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/deletebyokkeyresponse.mdx b/docs/models/components/deletebyokkeyresponse.mdx index a658459f3..77b479ff2 100644 --- a/docs/models/components/deletebyokkeyresponse.mdx +++ b/docs/models/components/deletebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file +| `Deleted` | `bool` | ✅ | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file diff --git a/docs/models/components/deleteguardrailresponse.mdx b/docs/models/components/deleteguardrailresponse.mdx index ee9b0e2bb..89d0213ed 100644 --- a/docs/models/components/deleteguardrailresponse.mdx +++ b/docs/models/components/deleteguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteGuardrailResponse" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file +| `Deleted` | `bool` | ✅ | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/docs/models/components/deleteinternrequest.mdx b/docs/models/components/deleteinternrequest.mdx index b2691a0d5..d768aac32 100644 --- a/docs/models/components/deleteinternrequest.mdx +++ b/docs/models/components/deleteinternrequest.mdx @@ -9,4 +9,4 @@ Optional consent for a teardown that discards the workspace. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `AcknowledgeWorkspaceLoss` | `*bool` | :heavy_minus_sign: | Delete even though the workspace backup was not confirmed. Defaults to false, which refuses the teardown when a workspace archive is missing. | \ No newline at end of file +| `AcknowledgeWorkspaceLoss` | `*bool` | ➖ | Delete even though the workspace backup was not confirmed. Defaults to false, which refuses the teardown when a workspace archive is missing. | \ No newline at end of file diff --git a/docs/models/components/deleteinternresponse.mdx b/docs/models/components/deleteinternresponse.mdx index 2d09b36db..b2c5be667 100644 --- a/docs/models/components/deleteinternresponse.mdx +++ b/docs/models/components/deleteinternresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Deleting` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Deleting` | `bool` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/deleteobservabilitydestinationresponse.mdx b/docs/models/components/deleteobservabilitydestinationresponse.mdx index 70b0298e4..f9ccc0664 100644 --- a/docs/models/components/deleteobservabilitydestinationresponse.mdx +++ b/docs/models/components/deleteobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteObservabilityDestinationResponse" | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Always `true` on success. | \ No newline at end of file +| `Deleted` | `bool` | ✅ | Always `true` on success. | \ No newline at end of file diff --git a/docs/models/components/deleteprivateendpointresponse.mdx b/docs/models/components/deleteprivateendpointresponse.mdx index de6692d25..2d90617f0 100644 --- a/docs/models/components/deleteprivateendpointresponse.mdx +++ b/docs/models/components/deleteprivateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "DeletePrivateEndpointResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.DeletePrivateEndpointResponseData](../../models/components/deleteprivateendpointresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.DeletePrivateEndpointResponseData](../../models/components/deleteprivateendpointresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/deleteprivateendpointresponsedata.mdx b/docs/models/components/deleteprivateendpointresponsedata.mdx index 71baa8231..30b1e6f79 100644 --- a/docs/models/components/deleteprivateendpointresponsedata.mdx +++ b/docs/models/components/deleteprivateendpointresponsedata.mdx @@ -6,4 +6,4 @@ title: "DeletePrivateEndpointResponseData" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/components/deletescimgroupmappingresponse.mdx b/docs/models/components/deletescimgroupmappingresponse.mdx index 2e155cc07..17491daf5 100644 --- a/docs/models/components/deletescimgroupmappingresponse.mdx +++ b/docs/models/components/deletescimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteScimGroupMappingResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Deleted` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Deleted` | `bool` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/deleteworkspacebudgetresponse.mdx b/docs/models/components/deleteworkspacebudgetresponse.mdx index 1bdca53e3..3bc166739 100644 --- a/docs/models/components/deleteworkspacebudgetresponse.mdx +++ b/docs/models/components/deleteworkspacebudgetresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file +| `Deleted` | `bool` | ✅ | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file diff --git a/docs/models/components/deleteworkspaceresponse.mdx b/docs/models/components/deleteworkspaceresponse.mdx index 895665447..a9c812cdb 100644 --- a/docs/models/components/deleteworkspaceresponse.mdx +++ b/docs/models/components/deleteworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "DeleteWorkspaceResponse" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the workspace was deleted | true | \ No newline at end of file +| `Deleted` | `bool` | ✅ | Confirmation that the workspace was deleted | true | \ No newline at end of file diff --git a/docs/models/components/easyinputmessage.mdx b/docs/models/components/easyinputmessage.mdx index 736d5df2e..6d8ba22a6 100644 --- a/docs/models/components/easyinputmessage.mdx +++ b/docs/models/components/easyinputmessage.mdx @@ -6,7 +6,7 @@ title: "EasyInputMessage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[components.EasyInputMessageContentUnion2](../../models/components/easyinputmessagecontentunion2.mdx)] | :heavy_minus_sign: | N/A | | -| `Phase` | optionalnullable.OptionalNullable[[components.EasyInputMessagePhaseUnion](../../models/components/easyinputmessagephaseunion.mdx)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer | -| `Role` | [components.EasyInputMessageRoleUnion](../../models/components/easyinputmessageroleunion.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [*components.EasyInputMessageTypeMessage](../../models/components/easyinputmessagetypemessage.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[components.EasyInputMessageContentUnion2](../../models/components/easyinputmessagecontentunion2.mdx)] | ➖ | N/A | | +| `Phase` | optionalnullable.OptionalNullable[[components.EasyInputMessagePhaseUnion](../../models/components/easyinputmessagephaseunion.mdx)] | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer | +| `Role` | [components.EasyInputMessageRoleUnion](../../models/components/easyinputmessageroleunion.mdx) | ✅ | N/A | | +| `Type` | [*components.EasyInputMessageTypeMessage](../../models/components/easyinputmessagetypemessage.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/easyinputmessagecontentinputimage.mdx b/docs/models/components/easyinputmessagecontentinputimage.mdx index 044ea66d3..bf042ea8f 100644 --- a/docs/models/components/easyinputmessagecontentinputimage.mdx +++ b/docs/models/components/easyinputmessagecontentinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.EasyInputMessageDetail](../../models/components/easyinputmessagedetail.mdx) | :heavy_check_mark: | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.EasyInputMessageTypeInputImage](../../models/components/easyinputmessagetypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Detail` | [components.EasyInputMessageDetail](../../models/components/easyinputmessagedetail.mdx) | ✅ | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.EasyInputMessageTypeInputImage](../../models/components/easyinputmessagetypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/edgenetworktimeoutresponseerrordata.mdx b/docs/models/components/edgenetworktimeoutresponseerrordata.mdx index 6039582e7..d3c21a9a2 100644 --- a/docs/models/components/edgenetworktimeoutresponseerrordata.mdx +++ b/docs/models/components/edgenetworktimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for EdgeNetworkTimeoutResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/editclearthinking20251015.mdx b/docs/models/components/editclearthinking20251015.mdx index fe22b8b8c..9b1d54f87 100644 --- a/docs/models/components/editclearthinking20251015.mdx +++ b/docs/models/components/editclearthinking20251015.mdx @@ -6,5 +6,5 @@ title: "EditClearThinking20251015" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Keep` | [*components.Keep](../../models/components/keep.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeClearThinking20251015](../../models/components/typeclearthinking20251015.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Keep` | [*components.Keep](../../models/components/keep.mdx) | ➖ | N/A | +| `Type` | [components.TypeClearThinking20251015](../../models/components/typeclearthinking20251015.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/editcleartooluses20250919.mdx b/docs/models/components/editcleartooluses20250919.mdx index c91abc41e..9d615885c 100644 --- a/docs/models/components/editcleartooluses20250919.mdx +++ b/docs/models/components/editcleartooluses20250919.mdx @@ -6,9 +6,9 @@ title: "EditClearToolUses20250919" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClearAtLeast` | optionalnullable.OptionalNullable[[components.AnthropicInputTokensClearAtLeast](../../models/components/anthropicinputtokensclearatleast.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | -| `ClearToolInputs` | optionalnullable.OptionalNullable[[components.ClearToolInputs](../../models/components/cleartoolinputs.mdx)] | :heavy_minus_sign: | N/A | | -| `ExcludeTools` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `Keep` | [*components.AnthropicToolUsesKeep](../../models/components/anthropictooluseskeep.mdx) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | -| `Trigger` | [*components.Trigger](../../models/components/trigger.mdx) | :heavy_minus_sign: | N/A | | -| `Type` | [components.TypeClearToolUses20250919](../../models/components/typecleartooluses20250919.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ClearAtLeast` | optionalnullable.OptionalNullable[[components.AnthropicInputTokensClearAtLeast](../../models/components/anthropicinputtokensclearatleast.mdx)] | ➖ | N/A | \{
"type": "input_tokens",
"value": 50000
} | +| `ClearToolInputs` | optionalnullable.OptionalNullable[[components.ClearToolInputs](../../models/components/cleartoolinputs.mdx)] | ➖ | N/A | | +| `ExcludeTools` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | +| `Keep` | [*components.AnthropicToolUsesKeep](../../models/components/anthropictooluseskeep.mdx) | ➖ | N/A | \{
"type": "tool_uses",
"value": 5
} | +| `Trigger` | [*components.Trigger](../../models/components/trigger.mdx) | ➖ | N/A | | +| `Type` | [components.TypeClearToolUses20250919](../../models/components/typecleartooluses20250919.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/editcompact20260112.mdx b/docs/models/components/editcompact20260112.mdx index c294056ba..8cb493fb9 100644 --- a/docs/models/components/editcompact20260112.mdx +++ b/docs/models/components/editcompact20260112.mdx @@ -6,7 +6,7 @@ title: "EditCompact20260112" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `PauseAfterCompaction` | `*bool` | :heavy_minus_sign: | N/A | | -| `Trigger` | optionalnullable.OptionalNullable[[components.TriggerInputTokens](../../models/components/triggerinputtokens.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | -| `Type` | [components.TypeCompact20260112](../../models/components/typecompact20260112.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Instructions` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `PauseAfterCompaction` | `*bool` | ➖ | N/A | | +| `Trigger` | optionalnullable.OptionalNullable[[components.TriggerInputTokens](../../models/components/triggerinputtokens.mdx)] | ➖ | N/A | \{
"type": "input_tokens",
"value": 100000
} | +| `Type` | [components.TypeCompact20260112](../../models/components/typecompact20260112.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/embeddings.mdx b/docs/models/components/embeddings.mdx index 9ab5f3958..6410696de 100644 --- a/docs/models/components/embeddings.mdx +++ b/docs/models/components/embeddings.mdx @@ -6,6 +6,6 @@ title: "Embeddings" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/endpointinfo.mdx b/docs/models/components/endpointinfo.mdx index f3a2d1c25..2e807e4d1 100644 --- a/docs/models/components/endpointinfo.mdx +++ b/docs/models/components/endpointinfo.mdx @@ -6,6 +6,6 @@ title: "EndpointInfo" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Provider` | `string` | :heavy_check_mark: | N/A | -| `Selected` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Model` | `string` | ✅ | N/A | +| `Provider` | `string` | ✅ | N/A | +| `Selected` | `bool` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/endpointsmetadata.mdx b/docs/models/components/endpointsmetadata.mdx index 68adcf3d8..99b5beaab 100644 --- a/docs/models/components/endpointsmetadata.mdx +++ b/docs/models/components/endpointsmetadata.mdx @@ -6,5 +6,5 @@ title: "EndpointsMetadata" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Available` | [][components.EndpointInfo](../../models/components/endpointinfo.mdx) | :heavy_check_mark: | N/A | -| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Available` | [][components.EndpointInfo](../../models/components/endpointinfo.mdx) | ✅ | N/A | +| `Total` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/enduser.mdx b/docs/models/components/enduser.mdx index 9dfecf17b..aa098b520 100644 --- a/docs/models/components/enduser.mdx +++ b/docs/models/components/enduser.mdx @@ -6,7 +6,7 @@ title: "EndUser" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | Registration creation time. | 2026-09-16T12:00:00Z | -| `IsActive` | `bool` | :heavy_check_mark: | Whether this registration is active. Not an inference authorization decision. | true | -| `UpdatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | -| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file +| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | Registration creation time. | 2026-09-16T12:00:00Z | +| `IsActive` | `bool` | ✅ | Whether this registration is active. Not an inference authorization decision. | true | +| `UpdatedAt` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | +| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file diff --git a/docs/models/components/enduserresponse.mdx b/docs/models/components/enduserresponse.mdx index cdc42980f..dd92c1729 100644 --- a/docs/models/components/enduserresponse.mdx +++ b/docs/models/components/enduserresponse.mdx @@ -6,4 +6,4 @@ title: "EndUserResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.EndUser](../../models/components/enduser.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
} | \ No newline at end of file +| `Data` | [components.EndUser](../../models/components/enduser.mdx) | ✅ | N/A | \{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
} | \ No newline at end of file diff --git a/docs/models/components/enumcapability.mdx b/docs/models/components/enumcapability.mdx index 8948f3874..11432f782 100644 --- a/docs/models/components/enumcapability.mdx +++ b/docs/models/components/enumcapability.mdx @@ -9,5 +9,5 @@ A parameter that accepts one of a discrete set of string values. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Type` | [components.EnumCapabilityType](../../models/components/enumcapabilitytype.mdx) | :heavy_check_mark: | N/A | -| `Values` | []`string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.EnumCapabilityType](../../models/components/enumcapabilitytype.mdx) | ✅ | N/A | +| `Values` | []`string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/errorevent.mdx b/docs/models/components/errorevent.mdx index 1d817e45d..4d0da7226 100644 --- a/docs/models/components/errorevent.mdx +++ b/docs/models/components/errorevent.mdx @@ -9,8 +9,8 @@ Event emitted when an error occurs during streaming | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Code` | `*string` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Param` | `*string` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ErrorEventType](../../models/components/erroreventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Code` | `*string` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Param` | `*string` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ErrorEventType](../../models/components/erroreventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/failedmodel.mdx b/docs/models/components/failedmodel.mdx index 0913c63d2..b83d615bc 100644 --- a/docs/models/components/failedmodel.mdx +++ b/docs/models/components/failedmodel.mdx @@ -6,6 +6,6 @@ title: "FailedModel" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Error` | `string` | :heavy_check_mark: | Error message describing why the model failed. | -| `Model` | `string` | :heavy_check_mark: | Slug of the analysis model that failed. | -| `StatusCode` | `*int64` | :heavy_minus_sign: | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file +| `Error` | `string` | ✅ | Error message describing why the model failed. | +| `Model` | `string` | ✅ | Slug of the analysis model that failed. | +| `StatusCode` | `*int64` | ➖ | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file diff --git a/docs/models/components/filecitation.mdx b/docs/models/components/filecitation.mdx index 94c5664c9..b58ad1812 100644 --- a/docs/models/components/filecitation.mdx +++ b/docs/models/components/filecitation.mdx @@ -6,7 +6,7 @@ title: "FileCitation" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `Index` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FileCitationType](../../models/components/filecitationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `Index` | `int64` | ✅ | N/A | +| `Type` | [components.FileCitationType](../../models/components/filecitationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fileparserplugin.mdx b/docs/models/components/fileparserplugin.mdx index bc1a76b33..0078bf85c 100644 --- a/docs/models/components/fileparserplugin.mdx +++ b/docs/models/components/fileparserplugin.mdx @@ -6,6 +6,6 @@ title: "FileParserPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | -| `ID` | [components.FileParserPluginID](../../models/components/fileparserpluginid.mdx) | :heavy_check_mark: | N/A | | -| `Pdf` | [*components.PDFParserOptions](../../models/components/pdfparseroptions.mdx) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | Set to false to disable the file-parser plugin for this request. Defaults to true. | | +| `ID` | [components.FileParserPluginID](../../models/components/fileparserpluginid.mdx) | ✅ | N/A | | +| `Pdf` | [*components.PDFParserOptions](../../models/components/pdfparseroptions.mdx) | ➖ | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file diff --git a/docs/models/components/filepath.mdx b/docs/models/components/filepath.mdx index f61c0fca2..7e14886bb 100644 --- a/docs/models/components/filepath.mdx +++ b/docs/models/components/filepath.mdx @@ -6,6 +6,6 @@ title: "FilePath" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Index` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FilePathType](../../models/components/filepathtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | +| `Index` | `int64` | ✅ | N/A | +| `Type` | [components.FilePathType](../../models/components/filepathtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/filesearchservertool.mdx b/docs/models/components/filesearchservertool.mdx index 43f1d7ae4..158840860 100644 --- a/docs/models/components/filesearchservertool.mdx +++ b/docs/models/components/filesearchservertool.mdx @@ -9,8 +9,8 @@ File search tool configuration | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Filters` | optionalnullable.OptionalNullable[[components.FiltersUnion](../../models/components/filtersunion.mdx)] | :heavy_minus_sign: | N/A | -| `MaxNumResults` | `*int64` | :heavy_minus_sign: | N/A | -| `RankingOptions` | [*components.RankingOptions](../../models/components/rankingoptions.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeFileSearch](../../models/components/typefilesearch.mdx) | :heavy_check_mark: | N/A | -| `VectorStoreIds` | []`string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Filters` | optionalnullable.OptionalNullable[[components.FiltersUnion](../../models/components/filtersunion.mdx)] | ➖ | N/A | +| `MaxNumResults` | `*int64` | ➖ | N/A | +| `RankingOptions` | [*components.RankingOptions](../../models/components/rankingoptions.mdx) | ➖ | N/A | +| `Type` | [components.TypeFileSearch](../../models/components/typefilesearch.mdx) | ✅ | N/A | +| `VectorStoreIds` | []`string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/filesservertool.mdx b/docs/models/components/filesservertool.mdx index ab8dab343..2be107981 100644 --- a/docs/models/components/filesservertool.mdx +++ b/docs/models/components/filesservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: read, write, edit, and list workspace files via | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `Parameters` | [*components.FilesServerToolConfig](../../models/components/filesservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | -| `Type` | [components.FilesServerToolType](../../models/components/filesservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.FilesServerToolConfig](../../models/components/filesservertoolconfig.mdx) | ➖ | Configuration for the openrouter:files server tool | \{} | +| `Type` | [components.FilesServerToolType](../../models/components/filesservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/filters.mdx b/docs/models/components/filters.mdx index 60fea37e5..6d8e6aa57 100644 --- a/docs/models/components/filters.mdx +++ b/docs/models/components/filters.mdx @@ -6,6 +6,6 @@ title: "Filters" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Key` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.FiltersType](../../models/components/filterstype.mdx) | :heavy_check_mark: | N/A | -| `Value` | [components.FileSearchServerToolValue2](../../models/components/filesearchservertoolvalue2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Key` | `string` | ✅ | N/A | +| `Type` | [components.FiltersType](../../models/components/filterstype.mdx) | ✅ | N/A | +| `Value` | [components.FileSearchServerToolValue2](../../models/components/filesearchservertoolvalue2.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/forbiddenresponseerrordata.mdx b/docs/models/components/forbiddenresponseerrordata.mdx index fdd1cee6f..0a70f6384 100644 --- a/docs/models/components/forbiddenresponseerrordata.mdx +++ b/docs/models/components/forbiddenresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ForbiddenResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/formatgrammar.mdx b/docs/models/components/formatgrammar.mdx index 135667ed3..3e88803d8 100644 --- a/docs/models/components/formatgrammar.mdx +++ b/docs/models/components/formatgrammar.mdx @@ -6,6 +6,6 @@ title: "FormatGrammar" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Definition` | `string` | :heavy_check_mark: | N/A | -| `Syntax` | [components.Syntax](../../models/components/syntax.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.FormatTypeGrammar](../../models/components/formattypegrammar.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Definition` | `string` | ✅ | N/A | +| `Syntax` | [components.Syntax](../../models/components/syntax.mdx) | ✅ | N/A | +| `Type` | [components.FormatTypeGrammar](../../models/components/formattypegrammar.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/formatjsonobjectconfig.mdx b/docs/models/components/formatjsonobjectconfig.mdx index 9c1f2765a..b0f3e3f45 100644 --- a/docs/models/components/formatjsonobjectconfig.mdx +++ b/docs/models/components/formatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.FormatJSONObjectConfigType](../../models/components/formatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FormatJSONObjectConfigType](../../models/components/formatjsonobjectconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/formatjsonschemaconfig.mdx b/docs/models/components/formatjsonschemaconfig.mdx index 8fe262e3b..b7b34d9bc 100644 --- a/docs/models/components/formatjsonschemaconfig.mdx +++ b/docs/models/components/formatjsonschemaconfig.mdx @@ -9,8 +9,8 @@ JSON schema constrained response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Description` | `*string` | :heavy_minus_sign: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Schema` | map[string]`any` | :heavy_check_mark: | N/A | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | -| `Type` | [components.FormatJSONSchemaConfigType](../../models/components/formatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Description` | `*string` | ➖ | N/A | +| `Name` | `string` | ✅ | N/A | +| `Schema` | map[string]`any` | ✅ | N/A | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | +| `Type` | [components.FormatJSONSchemaConfigType](../../models/components/formatjsonschemaconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/formattext.mdx b/docs/models/components/formattext.mdx index 0fdb00302..247a483e4 100644 --- a/docs/models/components/formattext.mdx +++ b/docs/models/components/formattext.mdx @@ -6,4 +6,4 @@ title: "FormatText" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Type` | [components.FormatTypeText](../../models/components/formattypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FormatTypeText](../../models/components/formattypetext.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/formattextconfig.mdx b/docs/models/components/formattextconfig.mdx index 81c37e82f..8a218ad9c 100644 --- a/docs/models/components/formattextconfig.mdx +++ b/docs/models/components/formattextconfig.mdx @@ -9,4 +9,4 @@ Plain text response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.FormatTextConfigType](../../models/components/formattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FormatTextConfigType](../../models/components/formattextconfigtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/frameimage.mdx b/docs/models/components/frameimage.mdx index daccd1cbb..1f7890601 100644 --- a/docs/models/components/frameimage.mdx +++ b/docs/models/components/frameimage.mdx @@ -6,6 +6,6 @@ title: "FrameImage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ImageURL` | [components.FrameImageImageURL](../../models/components/frameimageimageurl.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.FrameImageType](../../models/components/frameimagetype.mdx) | :heavy_check_mark: | N/A | | -| `FrameType` | [components.FrameType](../../models/components/frametype.mdx) | :heavy_check_mark: | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file +| `ImageURL` | [components.FrameImageImageURL](../../models/components/frameimageimageurl.mdx) | ✅ | N/A | | +| `Type` | [components.FrameImageType](../../models/components/frameimagetype.mdx) | ✅ | N/A | | +| `FrameType` | [components.FrameType](../../models/components/frametype.mdx) | ✅ | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file diff --git a/docs/models/components/frameimageimageurl.mdx b/docs/models/components/frameimageimageurl.mdx index 8bdba9c99..39cd43de0 100644 --- a/docs/models/components/frameimageimageurl.mdx +++ b/docs/models/components/frameimageimageurl.mdx @@ -6,4 +6,4 @@ title: "FrameImageImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/freemodeldailyrequests.mdx b/docs/models/components/freemodeldailyrequests.mdx index f158ace0e..e18912499 100644 --- a/docs/models/components/freemodeldailyrequests.mdx +++ b/docs/models/components/freemodeldailyrequests.mdx @@ -9,6 +9,6 @@ Free-model (`:free` variant) daily request quota for the account that owns the k | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Limit` | `int64` | :heavy_check_mark: | Free-model requests the account may make per UTC day; the ceiling depends on total credits purchased and is independent of `is_free_tier` | 50 | -| `Remaining` | `int64` | :heavy_check_mark: | Free-model requests left in the current UTC day | 38 | -| `Used` | `int64` | :heavy_check_mark: | Free-model requests recorded for the account so far in the current UTC day | 12 | \ No newline at end of file +| `Limit` | `int64` | ✅ | Free-model requests the account may make per UTC day; the ceiling depends on total credits purchased and is independent of `is_free_tier` | 50 | +| `Remaining` | `int64` | ✅ | Free-model requests left in the current UTC day | 38 | +| `Used` | `int64` | ✅ | Free-model requests recorded for the account so far in the current UTC day | 12 | \ No newline at end of file diff --git a/docs/models/components/functioncallargsdeltaevent.mdx b/docs/models/components/functioncallargsdeltaevent.mdx index fe87ef024..ae9f290b9 100644 --- a/docs/models/components/functioncallargsdeltaevent.mdx +++ b/docs/models/components/functioncallargsdeltaevent.mdx @@ -9,8 +9,8 @@ Event emitted when function call arguments are being streamed | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FunctionCallArgsDeltaEventType](../../models/components/functioncallargsdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FunctionCallArgsDeltaEventType](../../models/components/functioncallargsdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/functioncallargsdoneevent.mdx b/docs/models/components/functioncallargsdoneevent.mdx index 73e403d85..d4141284b 100644 --- a/docs/models/components/functioncallargsdoneevent.mdx +++ b/docs/models/components/functioncallargsdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when function call arguments streaming is complete | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FunctionCallArgsDoneEventType](../../models/components/functioncallargsdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FunctionCallArgsDoneEventType](../../models/components/functioncallargsdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/functioncallitem.mdx b/docs/models/components/functioncallitem.mdx index 82c411021..c75b6b7e8 100644 --- a/docs/models/components/functioncallitem.mdx +++ b/docs/models/components/functioncallitem.mdx @@ -9,13 +9,13 @@ A function call initiated by the model | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `Async` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `SubagentID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `SubagentItems` | optionalnullable.OptionalNullable[[][components.FunctionCallItemSubagentItem](../../models/components/functioncallitemsubagentitem.mdx)] | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | -| `Type` | [components.FunctionCallItemType](../../models/components/functioncallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | | +| `Async` | optionalnullable.OptionalNullable[`bool`] | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Namespace` | optionalnullable.OptionalNullable[`string`] | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | +| `SubagentID` | optionalnullable.OptionalNullable[`string`] | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `SubagentItems` | optionalnullable.OptionalNullable[[][components.FunctionCallItemSubagentItem](../../models/components/functioncallitemsubagentitem.mdx)] | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | +| `Type` | [components.FunctionCallItemType](../../models/components/functioncallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/functioncallitemsubagentitem.mdx b/docs/models/components/functioncallitemsubagentitem.mdx index 5df847fde..85a2fc0ac 100644 --- a/docs/models/components/functioncallitemsubagentitem.mdx +++ b/docs/models/components/functioncallitemsubagentitem.mdx @@ -6,5 +6,5 @@ title: "FunctionCallItemSubagentItem" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | `string` | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/functioncalloutputitem.mdx b/docs/models/components/functioncalloutputitem.mdx index 6260074c3..73b3b8ba3 100644 --- a/docs/models/components/functioncalloutputitem.mdx +++ b/docs/models/components/functioncalloutputitem.mdx @@ -9,8 +9,8 @@ The output from a function call execution | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Output` | [components.FunctionCallOutputItemOutputUnion2](../../models/components/functioncalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../../models/components/functioncalloutputitemtypefunctioncalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Output` | [components.FunctionCallOutputItemOutputUnion2](../../models/components/functioncalloutputitemoutputunion2.mdx) | ✅ | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | +| `Type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../../models/components/functioncalloutputitemtypefunctioncalloutput.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/functioncalloutputitemoutputinputimage.mdx b/docs/models/components/functioncalloutputitemoutputinputimage.mdx index f388a06c7..10dd44130 100644 --- a/docs/models/components/functioncalloutputitemoutputinputimage.mdx +++ b/docs/models/components/functioncalloutputitemoutputinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Detail` | [components.FunctionCallOutputItemDetail](../../models/components/functioncalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.FunctionCallOutputItemOutputType](../../models/components/functioncalloutputitemoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Detail` | [components.FunctionCallOutputItemDetail](../../models/components/functioncalloutputitemdetail.mdx) | ✅ | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.FunctionCallOutputItemOutputType](../../models/components/functioncalloutputitemoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusionanalysisresult.mdx b/docs/models/components/fusionanalysisresult.mdx index 2b8574ff9..b5434cf01 100644 --- a/docs/models/components/fusionanalysisresult.mdx +++ b/docs/models/components/fusionanalysisresult.mdx @@ -9,8 +9,8 @@ Structured analysis produced by the fusion analyst model. | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `BlindSpots` | []`string` | :heavy_check_mark: | N/A | -| `Consensus` | []`string` | :heavy_check_mark: | N/A | -| `Contradictions` | [][components.Contradiction](../../models/components/contradiction.mdx) | :heavy_check_mark: | N/A | -| `PartialCoverage` | [][components.PartialCoverage](../../models/components/partialcoverage.mdx) | :heavy_check_mark: | N/A | -| `UniqueInsights` | [][components.UniqueInsight](../../models/components/uniqueinsight.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `BlindSpots` | []`string` | ✅ | N/A | +| `Consensus` | []`string` | ✅ | N/A | +| `Contradictions` | [][components.Contradiction](../../models/components/contradiction.mdx) | ✅ | N/A | +| `PartialCoverage` | [][components.PartialCoverage](../../models/components/partialcoverage.mdx) | ✅ | N/A | +| `UniqueInsights` | [][components.UniqueInsight](../../models/components/uniqueinsight.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallanalysiscompletedevent.mdx b/docs/models/components/fusioncallanalysiscompletedevent.mdx index 1bccc6e82..54a4002e4 100644 --- a/docs/models/components/fusioncallanalysiscompletedevent.mdx +++ b/docs/models/components/fusioncallanalysiscompletedevent.mdx @@ -9,8 +9,8 @@ Emitted when the fusion analyst completes with the structured analysis. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Analysis` | [components.FusionAnalysisResult](../../models/components/fusionanalysisresult.mdx) | :heavy_check_mark: | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | -| `ItemID` | `string` | :heavy_check_mark: | N/A | | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.FusionCallAnalysisCompletedEventType](../../models/components/fusioncallanalysiscompletedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Analysis` | [components.FusionAnalysisResult](../../models/components/fusionanalysisresult.mdx) | ✅ | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | +| `ItemID` | `string` | ✅ | N/A | | +| `OutputIndex` | `int64` | ✅ | N/A | | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.FusionCallAnalysisCompletedEventType](../../models/components/fusioncallanalysiscompletedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/fusioncallanalysisinprogressevent.mdx b/docs/models/components/fusioncallanalysisinprogressevent.mdx index 4a41b40fe..6d0ba5a6f 100644 --- a/docs/models/components/fusioncallanalysisinprogressevent.mdx +++ b/docs/models/components/fusioncallanalysisinprogressevent.mdx @@ -9,9 +9,9 @@ Emitted when the fusion analyst starts producing the structured analysis. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AnalystModel` | `string` | :heavy_check_mark: | Slug of the model producing the structured analysis. | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| ~~`JudgeModel`~~ | `string` | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated alias of `analyst_model`, kept so existing consumers keep working. Always carries the same value. Use `analyst_model`. | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallAnalysisInProgressEventType](../../models/components/fusioncallanalysisinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `AnalystModel` | `string` | ✅ | Slug of the model producing the structured analysis. | +| `ItemID` | `string` | ✅ | N/A | +| ~~`JudgeModel`~~ | `string` | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated alias of `analyst_model`, kept so existing consumers keep working. Always carries the same value. Use `analyst_model`. | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FusionCallAnalysisInProgressEventType](../../models/components/fusioncallanalysisinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallcompletedevent.mdx b/docs/models/components/fusioncallcompletedevent.mdx index ade9c1d7d..21bea64b0 100644 --- a/docs/models/components/fusioncallcompletedevent.mdx +++ b/docs/models/components/fusioncallcompletedevent.mdx @@ -9,7 +9,7 @@ Emitted when the openrouter:fusion tool call finishes. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallCompletedEventType](../../models/components/fusioncallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FusionCallCompletedEventType](../../models/components/fusioncallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallinprogressevent.mdx b/docs/models/components/fusioncallinprogressevent.mdx index 22884b2a1..9b6b28e15 100644 --- a/docs/models/components/fusioncallinprogressevent.mdx +++ b/docs/models/components/fusioncallinprogressevent.mdx @@ -9,7 +9,7 @@ Emitted when an openrouter:fusion tool call begins executing. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallInProgressEventType](../../models/components/fusioncallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FusionCallInProgressEventType](../../models/components/fusioncallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpaneladdedevent.mdx b/docs/models/components/fusioncallpaneladdedevent.mdx index 08d121478..3b00fc790 100644 --- a/docs/models/components/fusioncallpaneladdedevent.mdx +++ b/docs/models/components/fusioncallpaneladdedevent.mdx @@ -9,8 +9,8 @@ Emitted when a fusion analysis-panel model starts. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallPanelAddedEventType](../../models/components/fusioncallpaneladdedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FusionCallPanelAddedEventType](../../models/components/fusioncallpaneladdedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelcompletedevent.mdx b/docs/models/components/fusioncallpanelcompletedevent.mdx index 8b41b3677..2018cd9e2 100644 --- a/docs/models/components/fusioncallpanelcompletedevent.mdx +++ b/docs/models/components/fusioncallpanelcompletedevent.mdx @@ -9,9 +9,9 @@ Emitted when a fusion panel model finishes with its full content. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Content` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallPanelCompletedEventType](../../models/components/fusioncallpanelcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FusionCallPanelCompletedEventType](../../models/components/fusioncallpanelcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpaneldeltaevent.mdx b/docs/models/components/fusioncallpaneldeltaevent.mdx index 7bfa29b8f..fa7d404bf 100644 --- a/docs/models/components/fusioncallpaneldeltaevent.mdx +++ b/docs/models/components/fusioncallpaneldeltaevent.mdx @@ -9,9 +9,9 @@ Incremental content token from a fusion panel model. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallPanelDeltaEventType](../../models/components/fusioncallpaneldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FusionCallPanelDeltaEventType](../../models/components/fusioncallpaneldeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelfailedevent.mdx b/docs/models/components/fusioncallpanelfailedevent.mdx index 0c0a45443..9c985ba28 100644 --- a/docs/models/components/fusioncallpanelfailedevent.mdx +++ b/docs/models/components/fusioncallpanelfailedevent.mdx @@ -9,10 +9,10 @@ Emitted when a fusion panel model fails. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Error` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `StatusCode` | `*int64` | :heavy_minus_sign: | N/A | -| `Type` | [components.FusionCallPanelFailedEventType](../../models/components/fusioncallpanelfailedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Error` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `StatusCode` | `*int64` | ➖ | N/A | +| `Type` | [components.FusionCallPanelFailedEventType](../../models/components/fusioncallpanelfailedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx b/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx index 6f9e454fc..361465812 100644 --- a/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx +++ b/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx @@ -9,9 +9,9 @@ Incremental reasoning token from a fusion panel model. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallPanelReasoningDeltaEventType](../../models/components/fusioncallpanelreasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.FusionCallPanelReasoningDeltaEventType](../../models/components/fusioncallpanelreasoningdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/fusionplugin.mdx b/docs/models/components/fusionplugin.mdx index cfee02f6c..59e1e8bee 100644 --- a/docs/models/components/fusionplugin.mdx +++ b/docs/models/components/fusionplugin.mdx @@ -6,10 +6,10 @@ title: "FusionPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AnalysisModels` | []`string` | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, slugs of models to run in parallel as the "expert panel" the analyst analyzes. Each model receives the same user prompt with web_search + web_fetch enabled. Capped at 8 models to bound cost amplification. When omitted, defaults to the Quality preset from the /labs/fusion UI (~anthropic/claude-opus-latest, ~openai/gpt-sol-latest, ~google/gemini-pro-latest). | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable Fusion configuration for a run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. Defaults to true. | | -| `ID` | [components.FusionPluginID](../../models/components/fusionpluginid.mdx) | :heavy_check_mark: | N/A | | -| `MaxToolCalls` | `*int64` | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | -| `Model` | `*string` | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the slug of the model that performs both the analyst step (with web_search + web_fetch) and the final synthesis. When omitted, defaults to the first model in the Quality preset. | ~anthropic/claude-opus-latest | -| `Preset` | [*components.PresetEnum](../../models/components/presetenum.mdx) | :heavy_minus_sign: | Configuration for a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. A curated OpenRouter preset (slugs follow `-`, e.g. `general-high`). Expands server-side into the preset's analysis_models panel and analyst model, so callers never name individual models. Explicitly provided `analysis_models` / `model` take precedence. | general-high | -| `Tools` | [][components.FusionPluginTool](../../models/components/fusionplugintool.mdx) | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file +| `AnalysisModels` | []`string` | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, slugs of models to run in parallel as the "expert panel" the analyst analyzes. Each model receives the same user prompt with web_search + web_fetch enabled. Capped at 8 models to bound cost amplification. When omitted, defaults to the Quality preset from the /labs/fusion UI (~anthropic/claude-opus-latest, ~openai/gpt-sol-latest, ~google/gemini-pro-latest). | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | +| `Enabled` | `*bool` | ➖ | Set to false to disable Fusion configuration for a run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. Defaults to true. | | +| `ID` | [components.FusionPluginID](../../models/components/fusionpluginid.mdx) | ✅ | N/A | | +| `MaxToolCalls` | `*int64` | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | +| `Model` | `*string` | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the slug of the model that performs both the analyst step (with web_search + web_fetch) and the final synthesis. When omitted, defaults to the first model in the Quality preset. | ~anthropic/claude-opus-latest | +| `Preset` | [*components.PresetEnum](../../models/components/presetenum.mdx) | ➖ | Configuration for a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. A curated OpenRouter preset (slugs follow `-`, e.g. `general-high`). Expands server-side into the preset's analysis_models panel and analyst model, so callers never name individual models. Explicitly provided `analysis_models` / `model` take precedence. | general-high | +| `Tools` | [][components.FusionPluginTool](../../models/components/fusionplugintool.mdx) | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file diff --git a/docs/models/components/fusionplugintool.mdx b/docs/models/components/fusionplugintool.mdx index 224921368..63ce10cbb 100644 --- a/docs/models/components/fusionplugintool.mdx +++ b/docs/models/components/fusionplugintool.mdx @@ -6,5 +6,5 @@ title: "FusionPluginTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `Parameters` | map[string][*components.Parameters3](../../models/components/parameters3.mdx) | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | -| `Type` | `string` | :heavy_check_mark: | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `Parameters` | map[string][*components.Parameters3](../../models/components/parameters3.mdx) | ➖ | Optional configuration forwarded as the tool's `parameters` object. | +| `Type` | `string` | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file diff --git a/docs/models/components/fusionservertoolconfig.mdx b/docs/models/components/fusionservertoolconfig.mdx index 53a2ab43c..a0dd32e9a 100644 --- a/docs/models/components/fusionservertoolconfig.mdx +++ b/docs/models/components/fusionservertoolconfig.mdx @@ -9,11 +9,11 @@ Configuration for the openrouter:fusion server tool. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AnalysisModels` | []`string` | :heavy_minus_sign: | Slugs of models to run in parallel as the analysis panel. Each model receives the user prompt with openrouter:web_search and openrouter:web_fetch enabled, then an analyst model summarizes the collective output into structured analysis JSON. Capped at 8 models to bound cost amplification. Defaults to the Quality preset from /labs/fusion. | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `MaxCompletionTokens` | `*int64` | :heavy_minus_sign: | Maximum number of output tokens (including reasoning tokens) each panelist and the analyst model may produce per inner call. Controls the total output budget so reasoning-heavy models like GPT-5.5 do not exhaust their token allowance before producing visible text. Defaults to 16000 when omitted. | 16384 | -| `MaxToolCalls` | `*int64` | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | -| `Model` | `*string` | :heavy_minus_sign: | Slug of the analyst model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | -| `Reasoning` | [*components.FusionServerToolConfigReasoning](../../models/components/fusionservertoolconfigreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to panelist and analyst inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | -| `Temperature` | `*float64` | :heavy_minus_sign: | Temperature forwarded to panelist inner calls. The analyst always runs at temperature 0 regardless of this value. When omitted, the provider's default applies. | 0.7 | -| `Tools` | [][components.FusionServerToolConfigTool](../../models/components/fusionservertoolconfigtool.mdx) | :heavy_minus_sign: | Server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file +| `AnalysisModels` | []`string` | ➖ | Slugs of models to run in parallel as the analysis panel. Each model receives the user prompt with openrouter:web_search and openrouter:web_fetch enabled, then an analyst model summarizes the collective output into structured analysis JSON. Capped at 8 models to bound cost amplification. Defaults to the Quality preset from /labs/fusion. | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `MaxCompletionTokens` | `*int64` | ➖ | Maximum number of output tokens (including reasoning tokens) each panelist and the analyst model may produce per inner call. Controls the total output budget so reasoning-heavy models like GPT-5.5 do not exhaust their token allowance before producing visible text. Defaults to 16000 when omitted. | 16384 | +| `MaxToolCalls` | `*int64` | ➖ | Maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | +| `Model` | `*string` | ➖ | Slug of the analyst model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | +| `Reasoning` | [*components.FusionServerToolConfigReasoning](../../models/components/fusionservertoolconfigreasoning.mdx) | ➖ | Reasoning configuration forwarded to panelist and analyst inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | +| `Temperature` | `*float64` | ➖ | Temperature forwarded to panelist inner calls. The analyst always runs at temperature 0 regardless of this value. When omitted, the provider's default applies. | 0.7 | +| `Tools` | [][components.FusionServerToolConfigTool](../../models/components/fusionservertoolconfigtool.mdx) | ➖ | Server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file diff --git a/docs/models/components/fusionservertoolconfigreasoning.mdx b/docs/models/components/fusionservertoolconfigreasoning.mdx index 5f5a7eed8..ce20470f6 100644 --- a/docs/models/components/fusionservertoolconfigreasoning.mdx +++ b/docs/models/components/fusionservertoolconfigreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to panelist and analyst inner calls. Use this | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Effort` | [*components.FusionServerToolConfigEffort](../../models/components/fusionservertoolconfigeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | -| `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens each panelist and analyst model may use. Helps bound cost when models allocate too much budget to chain-of-thought. | \ No newline at end of file +| `Effort` | [*components.FusionServerToolConfigEffort](../../models/components/fusionservertoolconfigeffort.mdx) | ➖ | Reasoning effort level for panelist and analyst inner calls. | +| `MaxTokens` | `*int64` | ➖ | Maximum number of reasoning tokens each panelist and analyst model may use. Helps bound cost when models allocate too much budget to chain-of-thought. | \ No newline at end of file diff --git a/docs/models/components/fusionservertoolconfigtool.mdx b/docs/models/components/fusionservertoolconfigtool.mdx index c49d55f54..6186cce8b 100644 --- a/docs/models/components/fusionservertoolconfigtool.mdx +++ b/docs/models/components/fusionservertoolconfigtool.mdx @@ -6,5 +6,5 @@ title: "FusionServerToolConfigTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `Parameters` | map[string]`any` | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | -| `Type` | `string` | :heavy_check_mark: | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `Parameters` | map[string]`any` | ➖ | Optional configuration forwarded as the tool's `parameters` object. | +| `Type` | `string` | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file diff --git a/docs/models/components/fusionservertoolopenrouter.mdx b/docs/models/components/fusionservertoolopenrouter.mdx index 72dc2a84c..e3906e7a2 100644 --- a/docs/models/components/fusionservertoolopenrouter.mdx +++ b/docs/models/components/fusionservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: fans out the user prompt to a panel of analysis | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.FusionServerToolConfig](../../models/components/fusionservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
]
} | -| `Type` | [components.FusionServerToolOpenRouterType](../../models/components/fusionservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.FusionServerToolConfig](../../models/components/fusionservertoolconfig.mdx) | ➖ | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
]
} | +| `Type` | [components.FusionServerToolOpenRouterType](../../models/components/fusionservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/fusionsource.mdx b/docs/models/components/fusionsource.mdx index 70328a8d9..760784e0e 100644 --- a/docs/models/components/fusionsource.mdx +++ b/docs/models/components/fusionsource.mdx @@ -9,5 +9,5 @@ A web page retrieved via web search during a fusion run. | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Title` | `string` | :heavy_check_mark: | Title of the retrieved web page. | -| `URL` | `string` | :heavy_check_mark: | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file +| `Title` | `string` | ✅ | Title of the retrieved web page. | +| `URL` | `string` | ✅ | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file diff --git a/docs/models/components/gatewaytimeoutresponseerrordata.mdx b/docs/models/components/gatewaytimeoutresponseerrordata.mdx index 7e28f3a3f..a3738575a 100644 --- a/docs/models/components/gatewaytimeoutresponseerrordata.mdx +++ b/docs/models/components/gatewaytimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for GatewayTimeoutResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/generationcontentdata.mdx b/docs/models/components/generationcontentdata.mdx index 62779e053..abf86e307 100644 --- a/docs/models/components/generationcontentdata.mdx +++ b/docs/models/components/generationcontentdata.mdx @@ -9,6 +9,6 @@ Stored prompt and completion content, plus the failure error when one was stored | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | [*components.GenerationContentError](../../models/components/generationcontenterror.mdx) | :heavy_check_mark: | The stored failure for this generation, or null when it succeeded | \{
"message": "Timed out waiting for the provider",
"previous_errors": [
\{
"code": 429,
"message": "Provider returned error",
"provider_name": "Google",
"raw": "\{\"error\":\{\"code\":429,\"message\":\"Resource exhausted\"}}"
}
],
"provider_name": "Vertex",
"raw": "\{\"error\":\{\"code\":504,\"message\":\"Deadline exceeded\"}}",
"status": 504
} | -| `Input` | [components.InputUnion](../../models/components/inputunion.mdx) | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | | -| `Output` | [components.GenerationContentDataOutput](../../models/components/generationcontentdataoutput.mdx) | :heavy_check_mark: | The output from the generation | | \ No newline at end of file +| `Error` | [*components.GenerationContentError](../../models/components/generationcontenterror.mdx) | ✅ | The stored failure for this generation, or null when it succeeded | \{
"message": "Timed out waiting for the provider",
"previous_errors": [
\{
"code": 429,
"message": "Provider returned error",
"provider_name": "Google",
"raw": "\{\"error\":\{\"code\":429,\"message\":\"Resource exhausted\"}}"
}
],
"provider_name": "Vertex",
"raw": "\{\"error\":\{\"code\":504,\"message\":\"Deadline exceeded\"}}",
"status": 504
} | +| `Input` | [components.InputUnion](../../models/components/inputunion.mdx) | ✅ | The input to the generation — either a prompt string or an array of messages | | +| `Output` | [components.GenerationContentDataOutput](../../models/components/generationcontentdataoutput.mdx) | ✅ | The output from the generation | | \ No newline at end of file diff --git a/docs/models/components/generationcontentdataoutput.mdx b/docs/models/components/generationcontentdataoutput.mdx index fedfa624b..2c33a346a 100644 --- a/docs/models/components/generationcontentdataoutput.mdx +++ b/docs/models/components/generationcontentdataoutput.mdx @@ -9,5 +9,5 @@ The output from the generation | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Completion` | `*string` | :heavy_check_mark: | The completion output | The meaning of life is a philosophical question... | -| `Reasoning` | `*string` | :heavy_check_mark: | Reasoning/thinking output, if any | null | \ No newline at end of file +| `Completion` | `*string` | ✅ | The completion output | The meaning of life is a philosophical question... | +| `Reasoning` | `*string` | ✅ | Reasoning/thinking output, if any | null | \ No newline at end of file diff --git a/docs/models/components/generationcontenterror.mdx b/docs/models/components/generationcontenterror.mdx index ee5798da6..c7af85f36 100644 --- a/docs/models/components/generationcontenterror.mdx +++ b/docs/models/components/generationcontenterror.mdx @@ -9,8 +9,8 @@ The stored failure for this generation, or null when it succeeded | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Message` | `*string` | :heavy_check_mark: | Error message returned to the client | Timed out waiting for the provider | -| `PreviousErrors` | [][components.GenerationContentErrorAttempt](../../models/components/generationcontenterrorattempt.mdx) | :heavy_check_mark: | Every upstream attempt that failed before the returned error, in attempt order | | -| `ProviderName` | `*string` | :heavy_check_mark: | Provider whose error was returned to the client, when known | Vertex | -| `Raw` | `*string` | :heavy_check_mark: | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | -| `Status` | `*int64` | :heavy_check_mark: | HTTP status returned to the client | 504 | \ No newline at end of file +| `Message` | `*string` | ✅ | Error message returned to the client | Timed out waiting for the provider | +| `PreviousErrors` | [][components.GenerationContentErrorAttempt](../../models/components/generationcontenterrorattempt.mdx) | ✅ | Every upstream attempt that failed before the returned error, in attempt order | | +| `ProviderName` | `*string` | ✅ | Provider whose error was returned to the client, when known | Vertex | +| `Raw` | `*string` | ✅ | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | +| `Status` | `*int64` | ✅ | HTTP status returned to the client | 504 | \ No newline at end of file diff --git a/docs/models/components/generationcontenterrorattempt.mdx b/docs/models/components/generationcontenterrorattempt.mdx index fab3b45f4..233ca6468 100644 --- a/docs/models/components/generationcontenterrorattempt.mdx +++ b/docs/models/components/generationcontenterrorattempt.mdx @@ -9,7 +9,7 @@ A single failed upstream attempt recorded for the generation | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | HTTP status returned by this attempt | 429 | -| `Message` | `string` | :heavy_check_mark: | Error message returned by this attempt | Provider returned error | -| `ProviderName` | `*string` | :heavy_check_mark: | Provider that served this attempt, when known | Google | -| `Raw` | `*string` | :heavy_check_mark: | Raw error body returned by the provider, when stored | \{"error":\{"code":429,"message":"Resource exhausted"}} | \ No newline at end of file +| `Code` | `int64` | ✅ | HTTP status returned by this attempt | 429 | +| `Message` | `string` | ✅ | Error message returned by this attempt | Provider returned error | +| `ProviderName` | `*string` | ✅ | Provider that served this attempt, when known | Google | +| `Raw` | `*string` | ✅ | Raw error body returned by the provider, when stored | \{"error":\{"code":429,"message":"Resource exhausted"}} | \ No newline at end of file diff --git a/docs/models/components/generationcontentresponse.mdx b/docs/models/components/generationcontentresponse.mdx index 5c1d31043..f28f40788 100644 --- a/docs/models/components/generationcontentresponse.mdx +++ b/docs/models/components/generationcontentresponse.mdx @@ -9,4 +9,4 @@ Stored prompt and completion content for a generation | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.GenerationContentData](../../models/components/generationcontentdata.mdx) | :heavy_check_mark: | Stored prompt and completion content, plus the failure error when one was stored | \{
"error": null,
"input": \{
"messages": [
\{
"content": "What is the meaning of life?",
"role": "user"
}
]
},
"output": \{
"completion": "The meaning of life is a philosophical question...",
"reasoning": null
}
} | \ No newline at end of file +| `Data` | [components.GenerationContentData](../../models/components/generationcontentdata.mdx) | ✅ | Stored prompt and completion content, plus the failure error when one was stored | \{
"error": null,
"input": \{
"messages": [
\{
"content": "What is the meaning of life?",
"role": "user"
}
]
},
"output": \{
"completion": "The meaning of life is a philosophical question...",
"reasoning": null
}
} | \ No newline at end of file diff --git a/docs/models/components/generationresponse.mdx b/docs/models/components/generationresponse.mdx index 11f8aa4d5..bab324c90 100644 --- a/docs/models/components/generationresponse.mdx +++ b/docs/models/components/generationresponse.mdx @@ -9,4 +9,4 @@ Generation response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.GenerationResponseData](../../models/components/generationresponsedata.mdx) | :heavy_check_mark: | Generation data | \ No newline at end of file +| `Data` | [components.GenerationResponseData](../../models/components/generationresponsedata.mdx) | ✅ | Generation data | \ No newline at end of file diff --git a/docs/models/components/generationresponsedata.mdx b/docs/models/components/generationresponsedata.mdx index d1c9630b0..7fe4b4ebd 100644 --- a/docs/models/components/generationresponsedata.mdx +++ b/docs/models/components/generationresponsedata.mdx @@ -9,48 +9,48 @@ Generation data | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIType` | [*components.APIType](../../models/components/apitype.mdx) | :heavy_check_mark: | Type of API used for the generation | | -| `AppID` | `*int64` | :heavy_check_mark: | ID of the app that made the request | 12345 | -| `CacheDiscount` | `*float64` | :heavy_check_mark: | Discount applied due to caching | 0.0002 | -| `Cancelled` | `*bool` | :heavy_check_mark: | Whether the generation was cancelled | false | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `DataRegion` | [components.GenerationResponseDataRegion](../../models/components/generationresponsedataregion.mdx) | :heavy_check_mark: | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | -| `ExternalUser` | `*string` | :heavy_check_mark: | External user identifier | user-123 | -| `FinishReason` | `*string` | :heavy_check_mark: | Reason the generation finished | stop | -| `GenerationTime` | `*float64` | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | -| `HTTPReferer` | `*string` | :heavy_check_mark: | Referer header from the request | | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `IsBYOK` | `bool` | :heavy_check_mark: | Whether this used bring-your-own-key | false | -| `Latency` | `*float64` | :heavy_check_mark: | Total latency in milliseconds | 1250 | -| `Model` | `string` | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | -| `ModerationLatency` | `*float64` | :heavy_check_mark: | Moderation latency in milliseconds | 50 | -| `NativeFinishReason` | `*string` | :heavy_check_mark: | Native finish reason as reported by provider | stop | -| `NativeTokensCached` | `*int64` | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | -| `NativeTokensCompletion` | `*int64` | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | -| `NativeTokensCompletionImages` | `*int64` | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | -| `NativeTokensPrompt` | `*int64` | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | -| `NativeTokensReasoning` | `*int64` | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | -| `NumFetches` | `*int64` | :heavy_check_mark: | Number of web fetches performed | 0 | -| `NumInputAudioPrompt` | `*int64` | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | -| `NumMediaCompletion` | `*int64` | :heavy_check_mark: | Number of media items in the completion | 0 | -| `NumMediaPrompt` | `*int64` | :heavy_check_mark: | Number of media items in the prompt | 1 | -| `NumSearchResults` | `*int64` | :heavy_check_mark: | Number of search results included | 5 | -| `Origin` | `string` | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | -| `PresetID` | `*string` | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | -| `ProviderName` | `*string` | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `ProviderResponses` | [][components.ProviderResponse](../../models/components/providerresponse.mdx) | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | -| `RequestID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | -| `ResponseCacheSourceID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | -| `Router` | `*string` | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | -| `ServiceTier` | `*string` | :heavy_check_mark: | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | -| `SessionID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Session identifier grouping multiple generations in the same session | | -| `Streamed` | `*bool` | :heavy_check_mark: | Whether the response was streamed | true | -| `TokensCompletion` | `*int64` | :heavy_check_mark: | Number of tokens in the completion | 25 | -| `TokensPrompt` | `*int64` | :heavy_check_mark: | Number of tokens in the prompt | 10 | -| `TotalCost` | `float64` | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | -| `UpstreamID` | `*string` | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `UpstreamInferenceCost` | `*float64` | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | -| `Usage` | `float64` | :heavy_check_mark: | Usage amount in USD | 0.0015 | -| `UserAgent` | `*string` | :heavy_check_mark: | User-Agent header from the request | | -| `WebSearchEngine` | `*string` | :heavy_check_mark: | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | -| `WorkspaceID` | `*string` | :heavy_check_mark: | ID of the workspace this generation is attributed to. Null for accounts without workspaces. Generations created before workspace resolution existed are attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIType` | [*components.APIType](../../models/components/apitype.mdx) | ✅ | Type of API used for the generation | | +| `AppID` | `*int64` | ✅ | ID of the app that made the request | 12345 | +| `CacheDiscount` | `*float64` | ✅ | Discount applied due to caching | 0.0002 | +| `Cancelled` | `*bool` | ✅ | Whether the generation was cancelled | false | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | +| `DataRegion` | [components.GenerationResponseDataRegion](../../models/components/generationresponsedataregion.mdx) | ✅ | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | +| `ExternalUser` | `*string` | ✅ | External user identifier | user-123 | +| `FinishReason` | `*string` | ✅ | Reason the generation finished | stop | +| `GenerationTime` | `*float64` | ✅ | Time taken for generation in milliseconds | 1200 | +| `HTTPReferer` | `*string` | ✅ | Referer header from the request | | +| `ID` | `string` | ✅ | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | +| `IsBYOK` | `bool` | ✅ | Whether this used bring-your-own-key | false | +| `Latency` | `*float64` | ✅ | Total latency in milliseconds | 1250 | +| `Model` | `string` | ✅ | Model used for the generation | sao10k/l3-stheno-8b | +| `ModerationLatency` | `*float64` | ✅ | Moderation latency in milliseconds | 50 | +| `NativeFinishReason` | `*string` | ✅ | Native finish reason as reported by provider | stop | +| `NativeTokensCached` | `*int64` | ✅ | Native cached tokens as reported by provider | 3 | +| `NativeTokensCompletion` | `*int64` | ✅ | Native completion tokens as reported by provider | 25 | +| `NativeTokensCompletionImages` | `*int64` | ✅ | Native completion image tokens as reported by provider | 0 | +| `NativeTokensPrompt` | `*int64` | ✅ | Native prompt tokens as reported by provider | 10 | +| `NativeTokensReasoning` | `*int64` | ✅ | Native reasoning tokens as reported by provider | 5 | +| `NumFetches` | `*int64` | ✅ | Number of web fetches performed | 0 | +| `NumInputAudioPrompt` | `*int64` | ✅ | Number of audio inputs in the prompt | 0 | +| `NumMediaCompletion` | `*int64` | ✅ | Number of media items in the completion | 0 | +| `NumMediaPrompt` | `*int64` | ✅ | Number of media items in the prompt | 1 | +| `NumSearchResults` | `*int64` | ✅ | Number of search results included | 5 | +| `Origin` | `string` | ✅ | Origin URL of the request | https://openrouter.ai/ | +| `PresetID` | `*string` | ✅ | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | +| `ProviderName` | `*string` | ✅ | Name of the provider that served the request | Infermatic | +| `ProviderResponses` | [][components.ProviderResponse](../../models/components/providerresponse.mdx) | ✅ | List of provider responses for this generation, including fallback attempts | | +| `RequestID` | optionalnullable.OptionalNullable[`string`] | ➖ | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | +| `ResponseCacheSourceID` | optionalnullable.OptionalNullable[`string`] | ➖ | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | +| `Router` | `*string` | ✅ | Router used for the request (e.g., openrouter/auto) | openrouter/auto | +| `ServiceTier` | `*string` | ✅ | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | +| `SessionID` | optionalnullable.OptionalNullable[`string`] | ➖ | Session identifier grouping multiple generations in the same session | | +| `Streamed` | `*bool` | ✅ | Whether the response was streamed | true | +| `TokensCompletion` | `*int64` | ✅ | Number of tokens in the completion | 25 | +| `TokensPrompt` | `*int64` | ✅ | Number of tokens in the prompt | 10 | +| `TotalCost` | `float64` | ✅ | Total cost of the generation in USD | 0.0015 | +| `UpstreamID` | `*string` | ✅ | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | +| `UpstreamInferenceCost` | `*float64` | ✅ | Cost charged by the upstream provider | 0.0012 | +| `Usage` | `float64` | ✅ | Usage amount in USD | 0.0015 | +| `UserAgent` | `*string` | ✅ | User-Agent header from the request | | +| `WebSearchEngine` | `*string` | ✅ | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | +| `WorkspaceID` | `*string` | ✅ | ID of the workspace this generation is attributed to. Null for accounts without workspaces. Generations created before workspace resolution existed are attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/getbyokkeyresponse.mdx b/docs/models/components/getbyokkeyresponse.mdx index dab47c1eb..ecf16b051 100644 --- a/docs/models/components/getbyokkeyresponse.mdx +++ b/docs/models/components/getbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "GetBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/getguardrailresponse.mdx b/docs/models/components/getguardrailresponse.mdx index 5ddc7239c..02e6e1c22 100644 --- a/docs/models/components/getguardrailresponse.mdx +++ b/docs/models/components/getguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "GetGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/components/getobservabilitydestinationresponse.mdx b/docs/models/components/getobservabilitydestinationresponse.mdx index ca8695ca4..1d909318b 100644 --- a/docs/models/components/getobservabilitydestinationresponse.mdx +++ b/docs/models/components/getobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "GetObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/getpresetresponse.mdx b/docs/models/components/getpresetresponse.mdx index 25f1369c5..2518e05fd 100644 --- a/docs/models/components/getpresetresponse.mdx +++ b/docs/models/components/getpresetresponse.mdx @@ -9,4 +9,4 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion.mdx) | :heavy_check_mark: | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file +| `Data` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion.mdx) | ✅ | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file diff --git a/docs/models/components/getpresetversionresponse.mdx b/docs/models/components/getpresetversionresponse.mdx index 522921fc5..6fe096b82 100644 --- a/docs/models/components/getpresetversionresponse.mdx +++ b/docs/models/components/getpresetversionresponse.mdx @@ -9,4 +9,4 @@ A single version of a preset. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | :heavy_check_mark: | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file +| `Data` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | ✅ | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file diff --git a/docs/models/components/getscimgroupmappingresponse.mdx b/docs/models/components/getscimgroupmappingresponse.mdx index 87fd9daba..85c7bf59f 100644 --- a/docs/models/components/getscimgroupmappingresponse.mdx +++ b/docs/models/components/getscimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "GetScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/getscimsyncjobresponse.mdx b/docs/models/components/getscimsyncjobresponse.mdx index 08b956297..4efc64b64 100644 --- a/docs/models/components/getscimsyncjobresponse.mdx +++ b/docs/models/components/getscimsyncjobresponse.mdx @@ -6,4 +6,4 @@ title: "GetScimSyncJobResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Data` | [components.ScimSyncJob](../../models/components/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.ScimSyncJob](../../models/components/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/gettoolresponse.mdx b/docs/models/components/gettoolresponse.mdx index 2d4e098d7..6ed055558 100644 --- a/docs/models/components/gettoolresponse.mdx +++ b/docs/models/components/gettoolresponse.mdx @@ -6,4 +6,4 @@ title: "GetToolResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Data` | [components.ServerToolDetails](../../models/components/servertooldetails.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.ServerToolDetails](../../models/components/servertooldetails.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/getworkspacebudgetresponse.mdx b/docs/models/components/getworkspacebudgetresponse.mdx index ef31c525d..732fd994c 100644 --- a/docs/models/components/getworkspacebudgetresponse.mdx +++ b/docs/models/components/getworkspacebudgetresponse.mdx @@ -6,5 +6,5 @@ title: "GetWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file +| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file diff --git a/docs/models/components/getworkspaceresponse.mdx b/docs/models/components/getworkspaceresponse.mdx index cb31c7200..a41105515 100644 --- a/docs/models/components/getworkspaceresponse.mdx +++ b/docs/models/components/getworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "GetWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `Data` | [components.Workspace](../../models/components/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/components/goneresponseerrordata.mdx b/docs/models/components/goneresponseerrordata.mdx index 3039016fc..eda84e5fd 100644 --- a/docs/models/components/goneresponseerrordata.mdx +++ b/docs/models/components/goneresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for GoneResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/guardrail.mdx b/docs/models/components/guardrail.mdx index 3d75395da..ffd9979d3 100644 --- a/docs/models/components/guardrail.mdx +++ b/docs/models/components/guardrail.mdx @@ -6,28 +6,28 @@ title: "Guardrail" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. | [
"europe"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntry](../../models/components/contentfilterbuiltinentry.mdx)] | :heavy_minus_sign: | Builtin content filters applied to requests. Includes PII detectors and the regex-based prompt injection detector. | [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
] | -| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters applied to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `IncludeBYOKInBudgets` | `bool` | :heavy_check_mark: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | -| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Spending limit in USD | 100 | -| `Name` | `string` | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `UpdatedAt` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `*string` | :heavy_check_mark: | The workspace this guardrail belongs to, or `null` for an unscoped legacy guardrail predating workspaces. Workspace membership organizes the guardrail; it does not apply the guardrail to the workspace's traffic. A `null` value does not mean the default workspace, and does not apply the guardrail across every workspace. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. | [
"europe"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntry](../../models/components/contentfilterbuiltinentry.mdx)] | ➖ | Builtin content filters applied to requests. Includes PII detectors and the regex-based prompt injection detector. | [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
] | +| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | ➖ | Custom regex content filters applied to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | Description of the guardrail | Guardrail for production environment | +| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | +| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | +| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `ID` | `string` | ✅ | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | +| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `IncludeBYOKInBudgets` | `bool` | ✅ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | +| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | ➖ | Spending limit in USD | 100 | +| `Name` | `string` | ✅ | Name of the guardrail | Production Guardrail | +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `UpdatedAt` | optionalnullable.OptionalNullable[`string`] | ➖ | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `*string` | ✅ | The workspace this guardrail belongs to, or `null` for an unscoped legacy guardrail predating workspaces. Workspace membership organizes the guardrail; it does not apply the guardrail to the workspace's traffic. A `null` value does not mean the default workspace, and does not apply the guardrail across every workspace. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/components/image.mdx b/docs/models/components/image.mdx index 76a7f7c79..cf4483767 100644 --- a/docs/models/components/image.mdx +++ b/docs/models/components/image.mdx @@ -6,5 +6,5 @@ title: "Image" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ImageURL` | [components.BatchObjectImageURL](../../models/components/batchobjectimageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChoiceTypeImageURL](../../models/components/choicetypeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.BatchObjectImageURL](../../models/components/batchobjectimageurl.mdx) | ✅ | N/A | +| `Type` | [components.ChoiceTypeImageURL](../../models/components/choicetypeimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/imageendpoint.mdx b/docs/models/components/imageendpoint.mdx index c0edb162a..11f6da29f 100644 --- a/docs/models/components/imageendpoint.mdx +++ b/docs/models/components/imageendpoint.mdx @@ -9,10 +9,10 @@ An endpoint that serves a given image model. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedPassthroughParameters` | []`string` | :heavy_check_mark: | Provider-specific options accepted under provider.options[provider_slug]. | [] | -| `Pricing` | [][components.ImagePricingEntry](../../models/components/imagepricingentry.mdx) | :heavy_check_mark: | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | -| `ProviderName` | `string` | :heavy_check_mark: | Provider display name | Bytedance | -| `ProviderSlug` | `string` | :heavy_check_mark: | Provider slug | bytedance | -| `ProviderTag` | `*string` | :heavy_check_mark: | Provider tag for request-side selection | bytedance | -| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | :heavy_check_mark: | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | -| `SupportsStreaming` | `bool` | :heavy_check_mark: | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file +| `AllowedPassthroughParameters` | []`string` | ✅ | Provider-specific options accepted under provider.options[provider_slug]. | [] | +| `Pricing` | [][components.ImagePricingEntry](../../models/components/imagepricingentry.mdx) | ✅ | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | +| `ProviderName` | `string` | ✅ | Provider display name | Bytedance | +| `ProviderSlug` | `string` | ✅ | Provider slug | bytedance | +| `ProviderTag` | `*string` | ✅ | Provider tag for request-side selection | bytedance | +| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | ✅ | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | +| `SupportsStreaming` | `bool` | ✅ | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file diff --git a/docs/models/components/imagegencallcompletedevent.mdx b/docs/models/components/imagegencallcompletedevent.mdx index c889cb29b..b481b2b82 100644 --- a/docs/models/components/imagegencallcompletedevent.mdx +++ b/docs/models/components/imagegencallcompletedevent.mdx @@ -9,7 +9,7 @@ Image generation call completed | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallCompletedEventType](../../models/components/imagegencallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ImageGenCallCompletedEventType](../../models/components/imagegencallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallgeneratingevent.mdx b/docs/models/components/imagegencallgeneratingevent.mdx index 5d6441a8f..6742e0501 100644 --- a/docs/models/components/imagegencallgeneratingevent.mdx +++ b/docs/models/components/imagegencallgeneratingevent.mdx @@ -9,7 +9,7 @@ Image generation call is generating | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallGeneratingEventType](../../models/components/imagegencallgeneratingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ImageGenCallGeneratingEventType](../../models/components/imagegencallgeneratingeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallinprogressevent.mdx b/docs/models/components/imagegencallinprogressevent.mdx index 9de51b343..0887462c2 100644 --- a/docs/models/components/imagegencallinprogressevent.mdx +++ b/docs/models/components/imagegencallinprogressevent.mdx @@ -9,7 +9,7 @@ Image generation call in progress | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallInProgressEventType](../../models/components/imagegencallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ImageGenCallInProgressEventType](../../models/components/imagegencallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallpartialimageevent.mdx b/docs/models/components/imagegencallpartialimageevent.mdx index bb25583fe..707a3d24e 100644 --- a/docs/models/components/imagegencallpartialimageevent.mdx +++ b/docs/models/components/imagegencallpartialimageevent.mdx @@ -9,9 +9,9 @@ Image generation call with partial image | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `PartialImageB64` | `string` | :heavy_check_mark: | N/A | -| `PartialImageIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallPartialImageEventType](../../models/components/imagegencallpartialimageeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `PartialImageB64` | `string` | ✅ | N/A | +| `PartialImageIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ImageGenCallPartialImageEventType](../../models/components/imagegencallpartialimageeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencompletedevent.mdx b/docs/models/components/imagegencompletedevent.mdx index a7420ac7c..6d9736d5b 100644 --- a/docs/models/components/imagegencompletedevent.mdx +++ b/docs/models/components/imagegencompletedevent.mdx @@ -9,8 +9,8 @@ Emitted when generation completes and the final image is available | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `B64JSON` | `string` | :heavy_check_mark: | Base64-encoded final image data | | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | | -| `MediaType` | `*string` | :heavy_minus_sign: | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | -| `Type` | [components.ImageGenCompletedEventType](../../models/components/imagegencompletedeventtype.mdx) | :heavy_check_mark: | The event type | | -| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage.mdx) | :heavy_minus_sign: | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file +| `B64JSON` | `string` | ✅ | Base64-encoded final image data | | +| `Created` | `int64` | ✅ | Unix timestamp (seconds) when the image was generated | | +| `MediaType` | `*string` | ➖ | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | +| `Type` | [components.ImageGenCompletedEventType](../../models/components/imagegencompletedeventtype.mdx) | ✅ | The event type | | +| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage.mdx) | ➖ | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file diff --git a/docs/models/components/imagegeneration.mdx b/docs/models/components/imagegeneration.mdx index 4e09cd3ed..6b6ddf16a 100644 --- a/docs/models/components/imagegeneration.mdx +++ b/docs/models/components/imagegeneration.mdx @@ -6,6 +6,6 @@ title: "ImageGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/imagegenerationproviderpreferences.mdx b/docs/models/components/imagegenerationproviderpreferences.mdx index 5fe499abf..ac592c75a 100644 --- a/docs/models/components/imagegenerationproviderpreferences.mdx +++ b/docs/models/components/imagegenerationproviderpreferences.mdx @@ -9,9 +9,9 @@ Provider routing preferences and provider-specific passthrough configuration. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `Ignore` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesIgnore](../../models/components/imagegenerationproviderpreferencesignore.mdx)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | -| `Only` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOnly](../../models/components/imagegenerationproviderpreferencesonly.mdx)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | -| `Options` | [*components.ImageGenerationProviderPreferencesOptions](../../models/components/imagegenerationproviderpreferencesoptions.mdx) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | -| `Order` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOrder](../../models/components/imagegenerationproviderpreferencesorder.mdx)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | -| `Sort` | optionalnullable.OptionalNullable[[components.ImageGenerationProviderPreferencesSort](../../models/components/imagegenerationproviderpreferencessort.mdx)] | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | \ No newline at end of file +| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `Ignore` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesIgnore](../../models/components/imagegenerationproviderpreferencesignore.mdx)] | ➖ | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | +| `Only` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOnly](../../models/components/imagegenerationproviderpreferencesonly.mdx)] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | +| `Options` | [*components.ImageGenerationProviderPreferencesOptions](../../models/components/imagegenerationproviderpreferencesoptions.mdx) | ➖ | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | +| `Order` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOrder](../../models/components/imagegenerationproviderpreferencesorder.mdx)] | ➖ | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | +| `Sort` | optionalnullable.OptionalNullable[[components.ImageGenerationProviderPreferencesSort](../../models/components/imagegenerationproviderpreferencessort.mdx)] | ➖ | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | \ No newline at end of file diff --git a/docs/models/components/imagegenerationproviderpreferencesoptions.mdx b/docs/models/components/imagegenerationproviderpreferencesoptions.mdx index 47ddabc35..2ac6ec07b 100644 --- a/docs/models/components/imagegenerationproviderpreferencesoptions.mdx +++ b/docs/models/components/imagegenerationproviderpreferencesoptions.mdx @@ -9,149 +9,149 @@ Provider-specific options keyed by provider slug. Only options for the matched p | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Oneai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ai21` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AionLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Akashml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Alibaba` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonBedrock` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonBedrockClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonNova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ambient` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anthropic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anthropic2` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anyscale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ArceeAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Assemblyai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AtlasCloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Atoma` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Avian` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Azure` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baidu` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baseten` | map[string]`any` | :heavy_minus_sign: | N/A | -| `BlackForestLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Byteplus` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Centml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cerebras` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Chutes` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cirrascale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Clarifai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cloudflare` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cohere` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Coreweave` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cosine` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crofai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crucible` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crusoe` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Darkbloom` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Databricks` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Decart` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepgram` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepinfra` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepseek` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Dekallm` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Digitalocean` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Elevenlabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Enfer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `FakeProvider` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Featherless` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Fireworks` | map[string]`any` | :heavy_minus_sign: | N/A | -| `FishAudio` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Friendli` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gmicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleAiStudio` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleVertex` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gopomelo` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Groq` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Heygen` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Huggingface` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Hyperbolic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `HyperbolicQuantized` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inception` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `InferactVllm` | map[string]`any` | :heavy_minus_sign: | N/A | -| `InferenceNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Infermatic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inocloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `IoNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ionstream` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Klusterai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Krea` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lambda` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lepton` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Liquid` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lynn` | map[string]`any` | :heavy_minus_sign: | N/A | -| `LynnPrivate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Makora` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mancer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `MancerOld` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mara` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Meta` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Minimax` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mistral` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modelrun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modular` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Moonshotai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Morph` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ncompass` | map[string]`any` | :heavy_minus_sign: | N/A | -| `NearAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nebius` | map[string]`any` | :heavy_minus_sign: | N/A | -| `NexAgi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nextbit` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nineteen` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Novita` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nvidia` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Octoai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ollama` | map[string]`any` | :heavy_minus_sign: | N/A | -| `OpenInference` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Openai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Parasail` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perplexity` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Phala` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Poolside` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Primeintellect` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Quiver` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recraft` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recursal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reka` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Relace` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Replicate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Respan` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Runway` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SailResearch` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sakana` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SakanaAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sambanova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SambanovaCloaked` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Scaledown` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Seed` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SfCompute` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Siliconflow` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sourceful` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stealth` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stepfun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Streamlake` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Switchpoint` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Targon` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Tencent` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Tenstorrent` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Thinkingmachines` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Together` | map[string]`any` | :heavy_minus_sign: | N/A | -| `TogetherLite` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Typesafe` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ubicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Unbiased` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Upstage` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Venice` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Voyageai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Wafer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Wandb` | map[string]`any` | :heavy_minus_sign: | N/A | -| `WandbLegacy` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xiaomi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ZAi` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Oneai` | map[string]`any` | ➖ | N/A | +| `Ai21` | map[string]`any` | ➖ | N/A | +| `AionLabs` | map[string]`any` | ➖ | N/A | +| `Akashml` | map[string]`any` | ➖ | N/A | +| `Alibaba` | map[string]`any` | ➖ | N/A | +| `AmazonBedrock` | map[string]`any` | ➖ | N/A | +| `AmazonBedrockClaudeOnAws` | map[string]`any` | ➖ | N/A | +| `AmazonNova` | map[string]`any` | ➖ | N/A | +| `Ambient` | map[string]`any` | ➖ | N/A | +| `Anthropic` | map[string]`any` | ➖ | N/A | +| `Anthropic2` | map[string]`any` | ➖ | N/A | +| `Anyscale` | map[string]`any` | ➖ | N/A | +| `ArceeAi` | map[string]`any` | ➖ | N/A | +| `Assemblyai` | map[string]`any` | ➖ | N/A | +| `AtlasCloud` | map[string]`any` | ➖ | N/A | +| `Atoma` | map[string]`any` | ➖ | N/A | +| `Avian` | map[string]`any` | ➖ | N/A | +| `Azure` | map[string]`any` | ➖ | N/A | +| `Baidu` | map[string]`any` | ➖ | N/A | +| `Baseten` | map[string]`any` | ➖ | N/A | +| `BlackForestLabs` | map[string]`any` | ➖ | N/A | +| `Byteplus` | map[string]`any` | ➖ | N/A | +| `Centml` | map[string]`any` | ➖ | N/A | +| `Cerebras` | map[string]`any` | ➖ | N/A | +| `Chutes` | map[string]`any` | ➖ | N/A | +| `Cirrascale` | map[string]`any` | ➖ | N/A | +| `Clarifai` | map[string]`any` | ➖ | N/A | +| `ClaudeOnAws` | map[string]`any` | ➖ | N/A | +| `Cloudflare` | map[string]`any` | ➖ | N/A | +| `Cohere` | map[string]`any` | ➖ | N/A | +| `Coreweave` | map[string]`any` | ➖ | N/A | +| `Cosine` | map[string]`any` | ➖ | N/A | +| `Crofai` | map[string]`any` | ➖ | N/A | +| `Crucible` | map[string]`any` | ➖ | N/A | +| `Crusoe` | map[string]`any` | ➖ | N/A | +| `Darkbloom` | map[string]`any` | ➖ | N/A | +| `Databricks` | map[string]`any` | ➖ | N/A | +| `Decart` | map[string]`any` | ➖ | N/A | +| `Deepgram` | map[string]`any` | ➖ | N/A | +| `Deepinfra` | map[string]`any` | ➖ | N/A | +| `Deepseek` | map[string]`any` | ➖ | N/A | +| `Dekallm` | map[string]`any` | ➖ | N/A | +| `Digitalocean` | map[string]`any` | ➖ | N/A | +| `Elevenlabs` | map[string]`any` | ➖ | N/A | +| `Enfer` | map[string]`any` | ➖ | N/A | +| `FakeProvider` | map[string]`any` | ➖ | N/A | +| `Featherless` | map[string]`any` | ➖ | N/A | +| `Fireworks` | map[string]`any` | ➖ | N/A | +| `FishAudio` | map[string]`any` | ➖ | N/A | +| `Friendli` | map[string]`any` | ➖ | N/A | +| `Gmicloud` | map[string]`any` | ➖ | N/A | +| `GoogleAiStudio` | map[string]`any` | ➖ | N/A | +| `GoogleVertex` | map[string]`any` | ➖ | N/A | +| `Gopomelo` | map[string]`any` | ➖ | N/A | +| `Groq` | map[string]`any` | ➖ | N/A | +| `Heygen` | map[string]`any` | ➖ | N/A | +| `Huggingface` | map[string]`any` | ➖ | N/A | +| `Hyperbolic` | map[string]`any` | ➖ | N/A | +| `HyperbolicQuantized` | map[string]`any` | ➖ | N/A | +| `Inception` | map[string]`any` | ➖ | N/A | +| `Inceptron` | map[string]`any` | ➖ | N/A | +| `InferactVllm` | map[string]`any` | ➖ | N/A | +| `InferenceNet` | map[string]`any` | ➖ | N/A | +| `Infermatic` | map[string]`any` | ➖ | N/A | +| `Inflection` | map[string]`any` | ➖ | N/A | +| `Inocloud` | map[string]`any` | ➖ | N/A | +| `IoNet` | map[string]`any` | ➖ | N/A | +| `Ionstream` | map[string]`any` | ➖ | N/A | +| `Klusterai` | map[string]`any` | ➖ | N/A | +| `Krea` | map[string]`any` | ➖ | N/A | +| `Lambda` | map[string]`any` | ➖ | N/A | +| `Lepton` | map[string]`any` | ➖ | N/A | +| `Liquid` | map[string]`any` | ➖ | N/A | +| `Lynn` | map[string]`any` | ➖ | N/A | +| `LynnPrivate` | map[string]`any` | ➖ | N/A | +| `Makora` | map[string]`any` | ➖ | N/A | +| `Mancer` | map[string]`any` | ➖ | N/A | +| `MancerOld` | map[string]`any` | ➖ | N/A | +| `Mara` | map[string]`any` | ➖ | N/A | +| `Meta` | map[string]`any` | ➖ | N/A | +| `Minimax` | map[string]`any` | ➖ | N/A | +| `Mistral` | map[string]`any` | ➖ | N/A | +| `Modal` | map[string]`any` | ➖ | N/A | +| `Modelrun` | map[string]`any` | ➖ | N/A | +| `Modular` | map[string]`any` | ➖ | N/A | +| `Moonshotai` | map[string]`any` | ➖ | N/A | +| `Morph` | map[string]`any` | ➖ | N/A | +| `Ncompass` | map[string]`any` | ➖ | N/A | +| `NearAi` | map[string]`any` | ➖ | N/A | +| `Nebius` | map[string]`any` | ➖ | N/A | +| `NexAgi` | map[string]`any` | ➖ | N/A | +| `Nextbit` | map[string]`any` | ➖ | N/A | +| `Nineteen` | map[string]`any` | ➖ | N/A | +| `Novita` | map[string]`any` | ➖ | N/A | +| `Nvidia` | map[string]`any` | ➖ | N/A | +| `Octoai` | map[string]`any` | ➖ | N/A | +| `Ollama` | map[string]`any` | ➖ | N/A | +| `OpenInference` | map[string]`any` | ➖ | N/A | +| `Openai` | map[string]`any` | ➖ | N/A | +| `Parasail` | map[string]`any` | ➖ | N/A | +| `Perceptron` | map[string]`any` | ➖ | N/A | +| `Perplexity` | map[string]`any` | ➖ | N/A | +| `Phala` | map[string]`any` | ➖ | N/A | +| `Poolside` | map[string]`any` | ➖ | N/A | +| `Primeintellect` | map[string]`any` | ➖ | N/A | +| `Quiver` | map[string]`any` | ➖ | N/A | +| `Recraft` | map[string]`any` | ➖ | N/A | +| `Recursal` | map[string]`any` | ➖ | N/A | +| `Reflection` | map[string]`any` | ➖ | N/A | +| `Reka` | map[string]`any` | ➖ | N/A | +| `Relace` | map[string]`any` | ➖ | N/A | +| `Replicate` | map[string]`any` | ➖ | N/A | +| `Respan` | map[string]`any` | ➖ | N/A | +| `Runway` | map[string]`any` | ➖ | N/A | +| `SailResearch` | map[string]`any` | ➖ | N/A | +| `Sakana` | map[string]`any` | ➖ | N/A | +| `SakanaAi` | map[string]`any` | ➖ | N/A | +| `Sambanova` | map[string]`any` | ➖ | N/A | +| `SambanovaCloaked` | map[string]`any` | ➖ | N/A | +| `Scaledown` | map[string]`any` | ➖ | N/A | +| `Seed` | map[string]`any` | ➖ | N/A | +| `SfCompute` | map[string]`any` | ➖ | N/A | +| `Siliconflow` | map[string]`any` | ➖ | N/A | +| `Sourceful` | map[string]`any` | ➖ | N/A | +| `Stealth` | map[string]`any` | ➖ | N/A | +| `Stepfun` | map[string]`any` | ➖ | N/A | +| `Streamlake` | map[string]`any` | ➖ | N/A | +| `Switchpoint` | map[string]`any` | ➖ | N/A | +| `Targon` | map[string]`any` | ➖ | N/A | +| `Tencent` | map[string]`any` | ➖ | N/A | +| `Tenstorrent` | map[string]`any` | ➖ | N/A | +| `Thinkingmachines` | map[string]`any` | ➖ | N/A | +| `Together` | map[string]`any` | ➖ | N/A | +| `TogetherLite` | map[string]`any` | ➖ | N/A | +| `Typesafe` | map[string]`any` | ➖ | N/A | +| `Ubicloud` | map[string]`any` | ➖ | N/A | +| `Unbiased` | map[string]`any` | ➖ | N/A | +| `Upstage` | map[string]`any` | ➖ | N/A | +| `Venice` | map[string]`any` | ➖ | N/A | +| `Voyageai` | map[string]`any` | ➖ | N/A | +| `Wafer` | map[string]`any` | ➖ | N/A | +| `Wandb` | map[string]`any` | ➖ | N/A | +| `WandbLegacy` | map[string]`any` | ➖ | N/A | +| `Xai` | map[string]`any` | ➖ | N/A | +| `Xiaomi` | map[string]`any` | ➖ | N/A | +| `ZAi` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegenerationrequest.mdx b/docs/models/components/imagegenerationrequest.mdx index 591544620..6be4687ae 100644 --- a/docs/models/components/imagegenerationrequest.mdx +++ b/docs/models/components/imagegenerationrequest.mdx @@ -9,20 +9,20 @@ Image generation request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AspectRatio` | [*components.ImageGenerationRequestAspectRatio](../../models/components/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `Background` | [*components.ImageGenerationRequestBackground](../../models/components/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `InputReferences` | [][components.ContentPartImage](../../models/components/contentpartimage.mdx) | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | -| `Model` | `string` | :heavy_check_mark: | The image generation model to use | bytedance-seed/seedream-4.5 | -| `N` | `*int64` | :heavy_minus_sign: | Upper bound on the number of images to generate (1-10). Providers may return fewer images, and providers that only support single-image generation reject n > 1. | 1 | -| `OutputCompression` | `*int64` | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `OutputFormat` | [*components.ImageGenerationRequestOutputFormat](../../models/components/imagegenerationrequestoutputformat.mdx) | :heavy_minus_sign: | Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`. | png | -| `Prompt` | `string` | :heavy_check_mark: | Text description of the desired image | a red panda astronaut floating in space, studio lighting | -| `Provider` | [*components.ImageGenerationProviderPreferences](../../models/components/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `Quality` | [*components.ImageGenerationRequestQuality](../../models/components/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | -| `Resolution` | [*components.ImageGenerationRequestResolution](../../models/components/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | -| `Seed` | `*int64` | :heavy_minus_sign: | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Size` | `*string` | :heavy_minus_sign: | Optional. A convenience shorthand for output dimensions — pass a tier ("2K", "4K") or explicit pixels ("2048x2048") and we normalize it to the right dimensions for the chosen provider. A tier size is equivalent to setting `resolution` and combines with `aspect_ratio`. An explicit pixel size is authoritative: a mismatched `resolution` or `aspect_ratio` alongside it is rejected with a 400. | 2K | -| `Stream` | `*bool` | :heavy_minus_sign: | If true, partial images are streamed as SSE events as they become available. Only supported by providers with native streaming (currently OpenAI). Non-streaming providers ignore this flag and return a buffered response. | | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | :heavy_minus_sign: | A stable identifier for your end-users. Used to help detect and prevent abuse. Never sent to providers verbatim: for providers whose data policy requires user IDs, it is folded into a hashed, per-account upstream user identifier. | end-user-abc123 | \ No newline at end of file +| `AspectRatio` | [*components.ImageGenerationRequestAspectRatio](../../models/components/imagegenerationrequestaspectratio.mdx) | ➖ | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `Background` | [*components.ImageGenerationRequestBackground](../../models/components/imagegenerationrequestbackground.mdx) | ➖ | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `InputReferences` | [][components.ContentPartImage](../../models/components/contentpartimage.mdx) | ➖ | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `Model` | `string` | ✅ | The image generation model to use | bytedance-seed/seedream-4.5 | +| `N` | `*int64` | ➖ | Upper bound on the number of images to generate (1-10). Providers may return fewer images, and providers that only support single-image generation reject n > 1. | 1 | +| `OutputCompression` | `*int64` | ➖ | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | +| `OutputFormat` | [*components.ImageGenerationRequestOutputFormat](../../models/components/imagegenerationrequestoutputformat.mdx) | ➖ | Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`. | png | +| `Prompt` | `string` | ✅ | Text description of the desired image | a red panda astronaut floating in space, studio lighting | +| `Provider` | [*components.ImageGenerationProviderPreferences](../../models/components/imagegenerationproviderpreferences.mdx) | ➖ | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `Quality` | [*components.ImageGenerationRequestQuality](../../models/components/imagegenerationrequestquality.mdx) | ➖ | Rendering quality. Providers without a quality knob ignore this. | high | +| `Resolution` | [*components.ImageGenerationRequestResolution](../../models/components/imagegenerationrequestresolution.mdx) | ➖ | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `Seed` | `*int64` | ➖ | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Size` | `*string` | ➖ | Optional. A convenience shorthand for output dimensions — pass a tier ("2K", "4K") or explicit pixels ("2048x2048") and we normalize it to the right dimensions for the chosen provider. A tier size is equivalent to setting `resolution` and combines with `aspect_ratio`. An explicit pixel size is authoritative: a mismatched `resolution` or `aspect_ratio` alongside it is rejected with a 400. | 2K | +| `Stream` | `*bool` | ➖ | If true, partial images are streamed as SSE events as they become available. Only supported by providers with native streaming (currently OpenAI). Non-streaming providers ignore this flag and return a buffered response. | | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | ➖ | A stable identifier for your end-users. Used to help detect and prevent abuse. Never sent to providers verbatim: for providers whose data policy requires user IDs, it is folded into a hashed, per-account upstream user identifier. | end-user-abc123 | \ No newline at end of file diff --git a/docs/models/components/imagegenerationresponse.mdx b/docs/models/components/imagegenerationresponse.mdx index 647efd062..80306ad6f 100644 --- a/docs/models/components/imagegenerationresponse.mdx +++ b/docs/models/components/imagegenerationresponse.mdx @@ -9,6 +9,6 @@ Image generation response | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | 1748372400 | -| `Data` | [][components.ImageGenerationResponseData](../../models/components/imagegenerationresponsedata.mdx) | :heavy_check_mark: | Generated images | | -| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage.mdx) | :heavy_minus_sign: | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file +| `Created` | `int64` | ✅ | Unix timestamp (seconds) when the image was generated | 1748372400 | +| `Data` | [][components.ImageGenerationResponseData](../../models/components/imagegenerationresponsedata.mdx) | ✅ | Generated images | | +| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage.mdx) | ➖ | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file diff --git a/docs/models/components/imagegenerationresponsedata.mdx b/docs/models/components/imagegenerationresponsedata.mdx index 059de7fe7..fb419aa93 100644 --- a/docs/models/components/imagegenerationresponsedata.mdx +++ b/docs/models/components/imagegenerationresponsedata.mdx @@ -6,5 +6,5 @@ title: "ImageGenerationResponseData" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `B64JSON` | `string` | :heavy_check_mark: | Base64-encoded image bytes | | -| `MediaType` | `*string` | :heavy_minus_sign: | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | \ No newline at end of file +| `B64JSON` | `string` | ✅ | Base64-encoded image bytes | | +| `MediaType` | `*string` | ➖ | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | \ No newline at end of file diff --git a/docs/models/components/imagegenerationservertool.mdx b/docs/models/components/imagegenerationservertool.mdx index c24479a3d..edc1d573e 100644 --- a/docs/models/components/imagegenerationservertool.mdx +++ b/docs/models/components/imagegenerationservertool.mdx @@ -9,14 +9,14 @@ Image generation tool configuration | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `Background` | [*components.ImageGenerationServerToolBackground](../../models/components/imagegenerationservertoolbackground.mdx) | :heavy_minus_sign: | N/A | -| `InputFidelity` | optionalnullable.OptionalNullable[[components.InputFidelity](../../models/components/inputfidelity.mdx)] | :heavy_minus_sign: | N/A | -| `InputImageMask` | [*components.InputImageMask](../../models/components/inputimagemask.mdx) | :heavy_minus_sign: | N/A | -| `Model` | `*string` | :heavy_minus_sign: | N/A | -| `Moderation` | [*components.Moderation](../../models/components/moderation.mdx) | :heavy_minus_sign: | N/A | -| `OutputCompression` | `*int64` | :heavy_minus_sign: | N/A | -| `OutputFormat` | [*components.ImageGenerationServerToolOutputFormat](../../models/components/imagegenerationservertooloutputformat.mdx) | :heavy_minus_sign: | N/A | -| `PartialImages` | `*int64` | :heavy_minus_sign: | N/A | -| `Quality` | [*components.ImageGenerationServerToolQuality](../../models/components/imagegenerationservertoolquality.mdx) | :heavy_minus_sign: | N/A | -| `Size` | `*string` | :heavy_minus_sign: | N/A | -| `Type` | [components.ImageGenerationServerToolType](../../models/components/imagegenerationservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Background` | [*components.ImageGenerationServerToolBackground](../../models/components/imagegenerationservertoolbackground.mdx) | ➖ | N/A | +| `InputFidelity` | optionalnullable.OptionalNullable[[components.InputFidelity](../../models/components/inputfidelity.mdx)] | ➖ | N/A | +| `InputImageMask` | [*components.InputImageMask](../../models/components/inputimagemask.mdx) | ➖ | N/A | +| `Model` | `*string` | ➖ | N/A | +| `Moderation` | [*components.Moderation](../../models/components/moderation.mdx) | ➖ | N/A | +| `OutputCompression` | `*int64` | ➖ | N/A | +| `OutputFormat` | [*components.ImageGenerationServerToolOutputFormat](../../models/components/imagegenerationservertooloutputformat.mdx) | ➖ | N/A | +| `PartialImages` | `*int64` | ➖ | N/A | +| `Quality` | [*components.ImageGenerationServerToolQuality](../../models/components/imagegenerationservertoolquality.mdx) | ➖ | N/A | +| `Size` | `*string` | ➖ | N/A | +| `Type` | [components.ImageGenerationServerToolType](../../models/components/imagegenerationservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegenerationservertoolconfig.mdx b/docs/models/components/imagegenerationservertoolconfig.mdx index 62883b6dd..cea9b5bd3 100644 --- a/docs/models/components/imagegenerationservertoolconfig.mdx +++ b/docs/models/components/imagegenerationservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:image_generation server tool. Accepts all image | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `Model` | `*string` | :heavy_minus_sign: | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | -| `AdditionalProperties` | map[string][components.ImageGenerationServerToolConfigUnion](../../models/components/imagegenerationservertoolconfigunion.mdx) | :heavy_minus_sign: | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file +| `Model` | `*string` | ➖ | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | +| `AdditionalProperties` | map[string][components.ImageGenerationServerToolConfigUnion](../../models/components/imagegenerationservertoolconfigunion.mdx) | ➖ | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file diff --git a/docs/models/components/imagegenerationservertoolopenrouter.mdx b/docs/models/components/imagegenerationservertoolopenrouter.mdx index d2b382539..8f8ff0440 100644 --- a/docs/models/components/imagegenerationservertoolopenrouter.mdx +++ b/docs/models/components/imagegenerationservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: generates images from text prompts using an ima | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ImageGenerationServerToolConfig](../../models/components/imagegenerationservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:image_generation server tool. Accepts all image_config params (aspect_ratio, quality, size, background, output_format, output_compression, moderation, etc.) plus a model field. | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | -| `Type` | [components.ImageGenerationServerToolOpenRouterType](../../models/components/imagegenerationservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.ImageGenerationServerToolConfig](../../models/components/imagegenerationservertoolconfig.mdx) | ➖ | Configuration for the openrouter:image_generation server tool. Accepts all image_config params (aspect_ratio, quality, size, background, output_format, output_compression, moderation, etc.) plus a model field. | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | +| `Type` | [components.ImageGenerationServerToolOpenRouterType](../../models/components/imagegenerationservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusage.mdx b/docs/models/components/imagegenerationusage.mdx index 0a440a4d1..e8a39b7a4 100644 --- a/docs/models/components/imagegenerationusage.mdx +++ b/docs/models/components/imagegenerationusage.mdx @@ -9,16 +9,16 @@ Token and cost usage for the image generation request, when available | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageCompletionTokensDetails](../../models/components/imagegenerationusagecompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | -| `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsagePromptTokensDetails](../../models/components/imagegenerationusageprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageServerToolUse](../../models/components/imagegenerationusageservertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | -| `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CompletionTokens` | `int64` | ✅ | The tokens generated | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageCompletionTokensDetails](../../models/components/imagegenerationusagecompletiontokensdetails.mdx)] | ➖ | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | ➖ | N/A | | +| `PromptTokens` | `int64` | ✅ | Including images, input audio, and tools if any | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsagePromptTokensDetails](../../models/components/imagegenerationusageprompttokensdetails.mdx)] | ➖ | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageServerToolUse](../../models/components/imagegenerationusageservertooluse.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | The service tier used by the upstream provider for this request | | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | ➖ | N/A | standard | +| `TotalTokens` | `int64` | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusagecompletiontokensdetails.mdx b/docs/models/components/imagegenerationusagecompletiontokensdetails.mdx index 0acb8d17b..bdef0ab07 100644 --- a/docs/models/components/imagegenerationusagecompletiontokensdetails.mdx +++ b/docs/models/components/imagegenerationusagecompletiontokensdetails.mdx @@ -6,6 +6,6 @@ title: "ImageGenerationUsageCompletionTokensDetails" | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for audio output. | +| `ImageTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for image output. | +| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusageprompttokensdetails.mdx b/docs/models/components/imagegenerationusageprompttokensdetails.mdx index bea48beee..e99012656 100644 --- a/docs/models/components/imagegenerationusageprompttokensdetails.mdx +++ b/docs/models/components/imagegenerationusageprompttokensdetails.mdx @@ -9,8 +9,8 @@ Breakdown of tokens used in the prompt. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input audio. | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input files/documents. | -| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input audio. | +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `CachedTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens cached by the endpoint. | +| `FileTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input files/documents. | +| `VideoTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusageservertooluse.mdx b/docs/models/components/imagegenerationusageservertooluse.mdx index 026d04635..436c7cc1d 100644 --- a/docs/models/components/imagegenerationusageservertooluse.mdx +++ b/docs/models/components/imagegenerationusageservertooluse.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/imagegenpartialimageevent.mdx b/docs/models/components/imagegenpartialimageevent.mdx index 2481d04e2..0e1bc5fc1 100644 --- a/docs/models/components/imagegenpartialimageevent.mdx +++ b/docs/models/components/imagegenpartialimageevent.mdx @@ -9,6 +9,6 @@ Emitted when a partial image becomes available during streaming generation | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `B64JSON` | `string` | :heavy_check_mark: | Base64-encoded partial image data | -| `PartialImageIndex` | `int64` | :heavy_check_mark: | 0-based index indicating which partial image this is in the sequence | -| `Type` | [components.ImageGenPartialImageEventType](../../models/components/imagegenpartialimageeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `B64JSON` | `string` | ✅ | Base64-encoded partial image data | +| `PartialImageIndex` | `int64` | ✅ | 0-based index indicating which partial image this is in the sequence | +| `Type` | [components.ImageGenPartialImageEventType](../../models/components/imagegenpartialimageeventtype.mdx) | ✅ | The event type | \ No newline at end of file diff --git a/docs/models/components/imagegenstreamerrorevent.mdx b/docs/models/components/imagegenstreamerrorevent.mdx index 3d9017709..7d6a04b0d 100644 --- a/docs/models/components/imagegenstreamerrorevent.mdx +++ b/docs/models/components/imagegenstreamerrorevent.mdx @@ -9,5 +9,5 @@ Emitted when streaming generation fails after the SSE response starts | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Error` | [components.ImageGenStreamErrorEventError](../../models/components/imagegenstreamerroreventerror.mdx) | :heavy_check_mark: | Provider error details | -| `Type` | [components.ImageGenStreamErrorEventType](../../models/components/imagegenstreamerroreventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `Error` | [components.ImageGenStreamErrorEventError](../../models/components/imagegenstreamerroreventerror.mdx) | ✅ | Provider error details | +| `Type` | [components.ImageGenStreamErrorEventType](../../models/components/imagegenstreamerroreventtype.mdx) | ✅ | The event type | \ No newline at end of file diff --git a/docs/models/components/imagegenstreamerroreventerror.mdx b/docs/models/components/imagegenstreamerroreventerror.mdx index 795edd62f..d63e94fb2 100644 --- a/docs/models/components/imagegenstreamerroreventerror.mdx +++ b/docs/models/components/imagegenstreamerroreventerror.mdx @@ -9,7 +9,7 @@ Provider error details | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Code` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Provider error code, when supplied | -| `Message` | `string` | :heavy_check_mark: | Provider error message | -| `Param` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Request parameter associated with the error, when supplied | -| `Type` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Provider error type, when supplied | \ No newline at end of file +| `Code` | optionalnullable.OptionalNullable[`string`] | ➖ | Provider error code, when supplied | +| `Message` | `string` | ✅ | Provider error message | +| `Param` | optionalnullable.OptionalNullable[`string`] | ➖ | Request parameter associated with the error, when supplied | +| `Type` | optionalnullable.OptionalNullable[`string`] | ➖ | Provider error type, when supplied | \ No newline at end of file diff --git a/docs/models/components/imagegentextchunkevent.mdx b/docs/models/components/imagegentextchunkevent.mdx index 46d1a6b30..e646227f4 100644 --- a/docs/models/components/imagegentextchunkevent.mdx +++ b/docs/models/components/imagegentextchunkevent.mdx @@ -9,6 +9,6 @@ Emitted when a text chunk becomes available during streaming generation of text- | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Phase` | [components.ImageGenTextChunkEventPhase](../../models/components/imagegentextchunkeventphase.mdx) | :heavy_check_mark: | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | -| `Text` | `string` | :heavy_check_mark: | A text fragment of the image being generated (e.g. partial SVG markup) | -| `Type` | [components.ImageGenTextChunkEventType](../../models/components/imagegentextchunkeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `Phase` | [components.ImageGenTextChunkEventPhase](../../models/components/imagegentextchunkeventphase.mdx) | ✅ | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | +| `Text` | `string` | ✅ | A text fragment of the image being generated (e.g. partial SVG markup) | +| `Type` | [components.ImageGenTextChunkEventType](../../models/components/imagegentextchunkeventtype.mdx) | ✅ | The event type | \ No newline at end of file diff --git a/docs/models/components/imagemodelarchitecture.mdx b/docs/models/components/imagemodelarchitecture.mdx index 467a9ccf1..c7fd8fee7 100644 --- a/docs/models/components/imagemodelarchitecture.mdx +++ b/docs/models/components/imagemodelarchitecture.mdx @@ -6,5 +6,5 @@ title: "ImageModelArchitecture" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `InputModalities` | [][components.ImageInputModality](../../models/components/imageinputmodality.mdx) | :heavy_check_mark: | Supported input modalities | -| `OutputModalities` | [][components.ImageOutputModality](../../models/components/imageoutputmodality.mdx) | :heavy_check_mark: | Supported output modalities | \ No newline at end of file +| `InputModalities` | [][components.ImageInputModality](../../models/components/imageinputmodality.mdx) | ✅ | Supported input modalities | +| `OutputModalities` | [][components.ImageOutputModality](../../models/components/imageoutputmodality.mdx) | ✅ | Supported output modalities | \ No newline at end of file diff --git a/docs/models/components/imagemodelendpointsresponse.mdx b/docs/models/components/imagemodelendpointsresponse.mdx index 8423e8460..e26c117f7 100644 --- a/docs/models/components/imagemodelendpointsresponse.mdx +++ b/docs/models/components/imagemodelendpointsresponse.mdx @@ -9,5 +9,5 @@ The full per-endpoint records for an image model. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Endpoints` | [][components.ImageEndpoint](../../models/components/imageendpoint.mdx) | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file +| `Endpoints` | [][components.ImageEndpoint](../../models/components/imageendpoint.mdx) | ✅ | N/A | | +| `ID` | `string` | ✅ | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file diff --git a/docs/models/components/imagemodellistitem.mdx b/docs/models/components/imagemodellistitem.mdx index 8d66095d4..50200d2b6 100644 --- a/docs/models/components/imagemodellistitem.mdx +++ b/docs/models/components/imagemodellistitem.mdx @@ -9,11 +9,11 @@ A single image model in the discovery listing. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Architecture` | [components.ImageModelArchitecture](../../models/components/imagemodelarchitecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) of when the model was created | 1692901234 | -| `Description` | `string` | :heavy_check_mark: | N/A | A text-to-image model. | -| `Endpoints` | `string` | :heavy_check_mark: | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | -| `ID` | `string` | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | -| `Name` | `string` | :heavy_check_mark: | Display name | Seedream 4.5 | -| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | :heavy_check_mark: | Union of supported parameters across every endpoint of this model. Coarse discovery aid; the definitive per-endpoint set is behind the endpoints URL. | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | -| `SupportsStreaming` | `bool` | :heavy_check_mark: | Whether any endpoint of this model supports native SSE streaming on the dedicated Image API (i.e. `stream: true` in the request). OR across endpoints. | false | \ No newline at end of file +| `Architecture` | [components.ImageModelArchitecture](../../models/components/imagemodelarchitecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | +| `Created` | `int64` | ✅ | Unix timestamp (seconds) of when the model was created | 1692901234 | +| `Description` | `string` | ✅ | N/A | A text-to-image model. | +| `Endpoints` | `string` | ✅ | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | +| `ID` | `string` | ✅ | Model slug | bytedance-seed/seedream-4.5 | +| `Name` | `string` | ✅ | Display name | Seedream 4.5 | +| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | ✅ | Union of supported parameters across every endpoint of this model. Coarse discovery aid; the definitive per-endpoint set is behind the endpoints URL. | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | +| `SupportsStreaming` | `bool` | ✅ | Whether any endpoint of this model supports native SSE streaming on the dedicated Image API (i.e. `stream: true` in the request). OR across endpoints. | false | \ No newline at end of file diff --git a/docs/models/components/imagemodelslistresponse.mdx b/docs/models/components/imagemodelslistresponse.mdx index 234ee1662..bd1378de7 100644 --- a/docs/models/components/imagemodelslistresponse.mdx +++ b/docs/models/components/imagemodelslistresponse.mdx @@ -9,4 +9,4 @@ List of image generation models. | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Data` | [][components.ImageModelListItem](../../models/components/imagemodellistitem.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.ImageModelListItem](../../models/components/imagemodellistitem.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/imagepricingentry.mdx b/docs/models/components/imagepricingentry.mdx index e31d3ea6c..12feb9b96 100644 --- a/docs/models/components/imagepricingentry.mdx +++ b/docs/models/components/imagepricingentry.mdx @@ -9,7 +9,7 @@ One billable pricing line for an image provider. | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Billable` | [components.Billable](../../models/components/billable.mdx) | :heavy_check_mark: | N/A | -| `CostUsd` | `float64` | :heavy_check_mark: | N/A | -| `Unit` | [components.Unit](../../models/components/unit.mdx) | :heavy_check_mark: | N/A | -| `Variant` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Billable` | [components.Billable](../../models/components/billable.mdx) | ✅ | N/A | +| `CostUsd` | `float64` | ✅ | N/A | +| `Unit` | [components.Unit](../../models/components/unit.mdx) | ✅ | N/A | +| `Variant` | `*string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/imagestreamingresponse.mdx b/docs/models/components/imagestreamingresponse.mdx index d5aa92cca..56212ecc3 100644 --- a/docs/models/components/imagestreamingresponse.mdx +++ b/docs/models/components/imagestreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ImageStreamingResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Data` | [components.ImageStreamingResponseData](../../models/components/imagestreamingresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.ImageStreamingResponseData](../../models/components/imagestreamingresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/incompletedetails.mdx b/docs/models/components/incompletedetails.mdx index 3943c325f..3f3e9ea0c 100644 --- a/docs/models/components/incompletedetails.mdx +++ b/docs/models/components/incompletedetails.mdx @@ -6,4 +6,4 @@ title: "IncompleteDetails" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `Reason` | [*components.IncompleteDetailsReason](../../models/components/incompletedetailsreason.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Reason` | [*components.IncompleteDetailsReason](../../models/components/incompletedetailsreason.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/input1.mdx b/docs/models/components/input1.mdx index 98b4ee8ae..db7ace533 100644 --- a/docs/models/components/input1.mdx +++ b/docs/models/components/input1.mdx @@ -6,4 +6,4 @@ title: "Input1" | Field | Type | Required | Description | Example | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `Prompt` | `string` | :heavy_check_mark: | N/A | What is the meaning of life? | \ No newline at end of file +| `Prompt` | `string` | ✅ | N/A | What is the meaning of life? | \ No newline at end of file diff --git a/docs/models/components/input2.mdx b/docs/models/components/input2.mdx index 124b13a76..54f5d77bc 100644 --- a/docs/models/components/input2.mdx +++ b/docs/models/components/input2.mdx @@ -6,4 +6,4 @@ title: "Input2" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `Messages` | []`any` | :heavy_check_mark: | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file +| `Messages` | []`any` | ✅ | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file diff --git a/docs/models/components/inputaudio.mdx b/docs/models/components/inputaudio.mdx index adb969735..3e07ec2f3 100644 --- a/docs/models/components/inputaudio.mdx +++ b/docs/models/components/inputaudio.mdx @@ -9,5 +9,5 @@ Audio input content item | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `InputAudio` | [components.InputAudioInputAudio](../../models/components/inputaudioinputaudio.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.InputAudioType](../../models/components/inputaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `InputAudio` | [components.InputAudioInputAudio](../../models/components/inputaudioinputaudio.mdx) | ✅ | N/A | +| `Type` | [components.InputAudioType](../../models/components/inputaudiotype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputaudioinputaudio.mdx b/docs/models/components/inputaudioinputaudio.mdx index 528acbfb8..80c8832c5 100644 --- a/docs/models/components/inputaudioinputaudio.mdx +++ b/docs/models/components/inputaudioinputaudio.mdx @@ -6,5 +6,5 @@ title: "InputAudioInputAudio" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `Format` | [components.FormatEnum](../../models/components/formatenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | `string` | ✅ | N/A | +| `Format` | [components.FormatEnum](../../models/components/formatenum.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputfile.mdx b/docs/models/components/inputfile.mdx index 68e85f5a5..41e5d2a0c 100644 --- a/docs/models/components/inputfile.mdx +++ b/docs/models/components/inputfile.mdx @@ -9,8 +9,8 @@ File input content item | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `FileData` | `*string` | :heavy_minus_sign: | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `FileURL` | `*string` | :heavy_minus_sign: | N/A | -| `Filename` | `*string` | :heavy_minus_sign: | N/A | -| `Type` | [components.InputFileType](../../models/components/inputfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileData` | `*string` | ➖ | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `FileURL` | `*string` | ➖ | N/A | +| `Filename` | `*string` | ➖ | N/A | +| `Type` | [components.InputFileType](../../models/components/inputfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputimage.mdx b/docs/models/components/inputimage.mdx index 0bf10da77..484e55206 100644 --- a/docs/models/components/inputimage.mdx +++ b/docs/models/components/inputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Detail` | [components.InputImageDetail](../../models/components/inputimagedetail.mdx) | :heavy_check_mark: | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.InputImageType](../../models/components/inputimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Detail` | [components.InputImageDetail](../../models/components/inputimagedetail.mdx) | ✅ | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.InputImageType](../../models/components/inputimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputimagemask.mdx b/docs/models/components/inputimagemask.mdx index 7da8bba2b..c2f53da00 100644 --- a/docs/models/components/inputimagemask.mdx +++ b/docs/models/components/inputimagemask.mdx @@ -6,5 +6,5 @@ title: "InputImageMask" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `FileID` | `*string` | :heavy_minus_sign: | N/A | -| `ImageURL` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `FileID` | `*string` | ➖ | N/A | +| `ImageURL` | `*string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputmessageitem.mdx b/docs/models/components/inputmessageitem.mdx index acd9e0a62..45d924321 100644 --- a/docs/models/components/inputmessageitem.mdx +++ b/docs/models/components/inputmessageitem.mdx @@ -6,7 +6,7 @@ title: "InputMessageItem" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.InputMessageItemContentUnion](../../models/components/inputmessageitemcontentunion.mdx)] | :heavy_minus_sign: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Role` | [components.InputMessageItemRoleUnion](../../models/components/inputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [*components.InputMessageItemTypeMessage](../../models/components/inputmessageitemtypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[][components.InputMessageItemContentUnion](../../models/components/inputmessageitemcontentunion.mdx)] | ➖ | N/A | +| `ID` | `*string` | ➖ | N/A | +| `Role` | [components.InputMessageItemRoleUnion](../../models/components/inputmessageitemroleunion.mdx) | ✅ | N/A | +| `Type` | [*components.InputMessageItemTypeMessage](../../models/components/inputmessageitemtypemessage.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputmessageitemcontentinputimage.mdx b/docs/models/components/inputmessageitemcontentinputimage.mdx index 6346e65d7..0cf5ecffd 100644 --- a/docs/models/components/inputmessageitemcontentinputimage.mdx +++ b/docs/models/components/inputmessageitemcontentinputimage.mdx @@ -9,7 +9,7 @@ Image input content item. Provide either an image_url (a URL or a base64 data UR | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.InputMessageItemDetail](../../models/components/inputmessageitemdetail.mdx) | :heavy_check_mark: | N/A | -| `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.InputMessageItemTypeInputImage](../../models/components/inputmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Detail` | [components.InputMessageItemDetail](../../models/components/inputmessageitemdetail.mdx) | ✅ | N/A | +| `FileID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ImageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.InputMessageItemTypeInputImage](../../models/components/inputmessageitemtypeinputimage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputschema.mdx b/docs/models/components/inputschema.mdx index d8ae85d5e..0b22ad2b4 100644 --- a/docs/models/components/inputschema.mdx +++ b/docs/models/components/inputschema.mdx @@ -6,7 +6,7 @@ title: "InputSchema" | Field | Type | Required | Description | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Properties` | `any` | :heavy_minus_sign: | N/A | -| `Required` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | -| `Type` | `*string` | :heavy_minus_sign: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Properties` | `any` | ➖ | N/A | +| `Required` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | +| `Type` | `*string` | ➖ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputsmessage.mdx b/docs/models/components/inputsmessage.mdx index 4bc50ecba..e0398f45f 100644 --- a/docs/models/components/inputsmessage.mdx +++ b/docs/models/components/inputsmessage.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InputsContent2](../../models/components/inputscontent2.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.InputsPhaseUnion](../../models/components/inputsphaseunion.mdx)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.InputsRole](../../models/components/inputsrole.mdx) | :heavy_check_mark: | N/A | -| `Status` | [*components.InputsStatusUnion1](../../models/components/inputsstatusunion1.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [*components.InputsTypeMessage](../../models/components/inputstypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Content` | [*components.InputsContent2](../../models/components/inputscontent2.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.InputsPhaseUnion](../../models/components/inputsphaseunion.mdx)] | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `Role` | [components.InputsRole](../../models/components/inputsrole.mdx) | ✅ | N/A | +| `Status` | [*components.InputsStatusUnion1](../../models/components/inputsstatusunion1.mdx) | ➖ | N/A | +| `Type` | [*components.InputsTypeMessage](../../models/components/inputstypemessage.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputsreasoning.mdx b/docs/models/components/inputsreasoning.mdx index d006dc3b6..34615e7c2 100644 --- a/docs/models/components/inputsreasoning.mdx +++ b/docs/models/components/inputsreasoning.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [*components.InputsStatusUnion2](../../models/components/inputsstatusunion2.mdx) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.InputsTypeReasoning](../../models/components/inputstypereasoning.mdx) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | -| `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | ➖ | N/A | | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Status` | [*components.InputsStatusUnion2](../../models/components/inputsstatusunion2.mdx) | ➖ | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | | +| `Type` | [components.InputsTypeReasoning](../../models/components/inputstypereasoning.mdx) | ✅ | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | +| `Signature` | optionalnullable.OptionalNullable[`string`] | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/components/inputtext.mdx b/docs/models/components/inputtext.mdx index 78cd13dcf..993c90722 100644 --- a/docs/models/components/inputtext.mdx +++ b/docs/models/components/inputtext.mdx @@ -9,6 +9,6 @@ Text input content item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint.mdx)] | :heavy_minus_sign: | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | -| `Text` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.InputTextType](../../models/components/inputtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint.mdx)] | ➖ | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | +| `Text` | `string` | ✅ | N/A | | +| `Type` | [components.InputTextType](../../models/components/inputtexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/inputtokensdetails.mdx b/docs/models/components/inputtokensdetails.mdx index 655e5a672..2391d48a5 100644 --- a/docs/models/components/inputtokensdetails.mdx +++ b/docs/models/components/inputtokensdetails.mdx @@ -6,5 +6,5 @@ title: "InputTokensDetails" | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `CachedTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `CacheWriteTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | +| `CachedTokens` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/inputvideo.mdx b/docs/models/components/inputvideo.mdx index 1865f1363..b05c03e31 100644 --- a/docs/models/components/inputvideo.mdx +++ b/docs/models/components/inputvideo.mdx @@ -9,6 +9,6 @@ Video input content item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Processing` | [*components.InputVideoProcessing](../../models/components/inputvideoprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `Type` | [components.InputVideoType](../../models/components/inputvideotype.mdx) | :heavy_check_mark: | N/A | | -| `VideoURL` | `string` | :heavy_check_mark: | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file +| `Processing` | [*components.InputVideoProcessing](../../models/components/inputvideoprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `Type` | [components.InputVideoType](../../models/components/inputvideotype.mdx) | ✅ | N/A | | +| `VideoURL` | `string` | ✅ | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file diff --git a/docs/models/components/intern.mdx b/docs/models/components/intern.mdx index 58dbfefb4..ef9b504d2 100644 --- a/docs/models/components/intern.mdx +++ b/docs/models/components/intern.mdx @@ -9,17 +9,17 @@ Public lifecycle state and settings for one intern. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `AttachedVaultID` | `*string` | :heavy_check_mark: | Vault the intern borrows from another intern, or null when it borrows none. | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 creation time. | -| `Description` | `*string` | :heavy_check_mark: | Free-form description. | -| `Hostname` | `*string` | :heavy_check_mark: | Public hostname the intern is reachable at, or null until provisioning has assigned one. | -| `ID` | `string` | :heavy_check_mark: | Intern id. | -| `Instructions` | `*string` | :heavy_check_mark: | Standing instructions the intern boots with. | -| `LastFailureMessage` | `*string` | :heavy_check_mark: | Why the last provisioning attempt failed, when status is failed. | -| `Model` | `*string` | :heavy_check_mark: | OpenRouter model slug the intern runs, or null for the workspace default. | -| `Name` | `string` | :heavy_check_mark: | Intern name, unique per creator within a workspace. | -| `Progress` | [*components.Progress](../../models/components/progress.mdx) | :heavy_check_mark: | Active provisioning step, or null once provisioning has settled. | -| `Status` | [components.InternStatus](../../models/components/internstatus.mdx) | :heavy_check_mark: | Lifecycle status. | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO 8601 last update time. | -| `VaultID` | `*string` | :heavy_check_mark: | Vault the intern owns, or null before it has been created. | -| `WorkspaceID` | `string` | :heavy_check_mark: | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file +| `AttachedVaultID` | `*string` | ✅ | Vault the intern borrows from another intern, or null when it borrows none. | +| `CreatedAt` | `string` | ✅ | ISO 8601 creation time. | +| `Description` | `*string` | ✅ | Free-form description. | +| `Hostname` | `*string` | ✅ | Public hostname the intern is reachable at, or null until provisioning has assigned one. | +| `ID` | `string` | ✅ | Intern id. | +| `Instructions` | `*string` | ✅ | Standing instructions the intern boots with. | +| `LastFailureMessage` | `*string` | ✅ | Why the last provisioning attempt failed, when status is failed. | +| `Model` | `*string` | ✅ | OpenRouter model slug the intern runs, or null for the workspace default. | +| `Name` | `string` | ✅ | Intern name, unique per creator within a workspace. | +| `Progress` | [*components.Progress](../../models/components/progress.mdx) | ✅ | Active provisioning step, or null once provisioning has settled. | +| `Status` | [components.InternStatus](../../models/components/internstatus.mdx) | ✅ | Lifecycle status. | +| `UpdatedAt` | `string` | ✅ | ISO 8601 last update time. | +| `VaultID` | `*string` | ✅ | Vault the intern owns, or null before it has been created. | +| `WorkspaceID` | `string` | ✅ | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file diff --git a/docs/models/components/internalserverresponseerrordata.mdx b/docs/models/components/internalserverresponseerrordata.mdx index 7af4937fc..6b89dcbcb 100644 --- a/docs/models/components/internalserverresponseerrordata.mdx +++ b/docs/models/components/internalserverresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for InternalServerResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/internchatassistantmessage.mdx b/docs/models/components/internchatassistantmessage.mdx index 9acf19ded..0573a033c 100644 --- a/docs/models/components/internchatassistantmessage.mdx +++ b/docs/models/components/internchatassistantmessage.mdx @@ -9,6 +9,6 @@ An assistant message from an earlier response. When answering an interaction, ec | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx)] | :heavy_minus_sign: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatAssistantMessageRole](../../models/components/internchatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `ToolCalls` | [][components.InternChatEchoedToolCall](../../models/components/internchatechoedtoolcall.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx)] | ➖ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatAssistantMessageRole](../../models/components/internchatassistantmessagerole.mdx) | ✅ | N/A | | +| `ToolCalls` | [][components.InternChatEchoedToolCall](../../models/components/internchatechoedtoolcall.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatchoice.mdx b/docs/models/components/internchatchoice.mdx index 664c706b9..8ea4214f2 100644 --- a/docs/models/components/internchatchoice.mdx +++ b/docs/models/components/internchatchoice.mdx @@ -9,6 +9,6 @@ The single choice this endpoint streams. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Delta` | [components.InternChatDelta](../../models/components/internchatdelta.mdx) | :heavy_check_mark: | The incremental content of one chunk. The first chunk carries `role`, text chunks carry `content`, reasoning chunks carry `reasoning`, and an interaction chunk carries one complete `tool_calls` entry. | \{
"content": "Hello"
} | -| `FinishReason` | [*components.InternChatChoiceFinishReason](../../models/components/internchatchoicefinishreason.mdx) | :heavy_check_mark: | `null` while streaming. `stop` when the run completed, `tool_calls` when the run is waiting for the caller to answer the streamed tool call, `error` on the terminal error chunk. | | -| `Index` | `int64` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Delta` | [components.InternChatDelta](../../models/components/internchatdelta.mdx) | ✅ | The incremental content of one chunk. The first chunk carries `role`, text chunks carry `content`, reasoning chunks carry `reasoning`, and an interaction chunk carries one complete `tool_calls` entry. | \{
"content": "Hello"
} | +| `FinishReason` | [*components.InternChatChoiceFinishReason](../../models/components/internchatchoicefinishreason.mdx) | ✅ | `null` while streaming. `stop` when the run completed, `tool_calls` when the run is waiting for the caller to answer the streamed tool call, `error` on the terminal error chunk. | | +| `Index` | `int64` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatcompletionchunk.mdx b/docs/models/components/internchatcompletionchunk.mdx index dab91c511..99f29517e 100644 --- a/docs/models/components/internchatcompletionchunk.mdx +++ b/docs/models/components/internchatcompletionchunk.mdx @@ -9,11 +9,11 @@ One `data:` line of the stream. A run streams a role chunk, content and reasonin | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.InternChatChoice](../../models/components/internchatchoice.mdx) | :heavy_check_mark: | One choice on content, tool-call and error chunks. Empty on the final chunk that carries `session_id`. | | -| `Created` | `int64` | :heavy_check_mark: | N/A | | -| `Error` | [*components.InternChatStreamError](../../models/components/internchatstreamerror.mdx) | :heavy_minus_sign: | A failure after the response headers were sent. The chunk that carries it has `finish_reason: "error"`, then the final empty-`choices` chunk and `[DONE]` follow. Reasons here are `attachment_failed`, `busy`, `client_closed_request`, `interaction_not_pending`, `interaction_unknown`, `intern_unreachable`, `run_ended`, `stream_severed`, `timeout` or `turn_failed`. `run_ended` reports an ending the intern confirmed, such as a cancellation or a deadline, while `stream_severed` reports a connection lost without that confirmation. | \{
"code": 502,
"message": "The intern could not continue this run.",
"metadata": \{
"reason": "attachment_failed",
"retryable": false
}
} | -| `ID` | `string` | :heavy_check_mark: | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | -| `Model` | `string` | :heavy_check_mark: | The runtime's identifier for the model the intern is running, as the intern reports it. Each chunk carries the model from the event behind it: `openrouter/intern` on chunks emitted before the intern has reported one and on chunks the API emits itself (timeout, run-ended and severed-stream errors and their final usage chunk), even after an earlier chunk named a model. It can change within a stream. It is not an OpenRouter model slug, and the request `model` is never used. | | -| `Object` | [components.InternChatCompletionChunkObject](../../models/components/internchatcompletionchunkobject.mdx) | :heavy_check_mark: | N/A | | -| `SessionID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | On the final chunk of every response, the daemon session to continue with, or `null` when the run failed before the intern reported one. Send it as `session_id` on the next request, including the `tool` reply to an interaction. Session ids are client-visible and scoped to the intern's own daemon. | ses_7f3c9a | -| `Usage` | optionalnullable.OptionalNullable[[components.InternChatUsage](../../models/components/internchatusage.mdx)] | :heavy_minus_sign: | Token usage for the run as the daemon reported it, on the final chunk before `[DONE]`. `null` when the daemon reported none, and always `null` after `tool_calls` because the turn is not over. | \{
"completion_tokens": 12,
"prompt_tokens": 40,
"total_tokens": 52
} | \ No newline at end of file +| `Choices` | [][components.InternChatChoice](../../models/components/internchatchoice.mdx) | ✅ | One choice on content, tool-call and error chunks. Empty on the final chunk that carries `session_id`. | | +| `Created` | `int64` | ✅ | N/A | | +| `Error` | [*components.InternChatStreamError](../../models/components/internchatstreamerror.mdx) | ➖ | A failure after the response headers were sent. The chunk that carries it has `finish_reason: "error"`, then the final empty-`choices` chunk and `[DONE]` follow. Reasons here are `attachment_failed`, `busy`, `client_closed_request`, `interaction_not_pending`, `interaction_unknown`, `intern_unreachable`, `run_ended`, `stream_severed`, `timeout` or `turn_failed`. `run_ended` reports an ending the intern confirmed, such as a cancellation or a deadline, while `stream_severed` reports a connection lost without that confirmation. | \{
"code": 502,
"message": "The intern could not continue this run.",
"metadata": \{
"reason": "attachment_failed",
"retryable": false
}
} | +| `ID` | `string` | ✅ | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | +| `Model` | `string` | ✅ | The runtime's identifier for the model the intern is running, as the intern reports it. Each chunk carries the model from the event behind it: `openrouter/intern` on chunks emitted before the intern has reported one and on chunks the API emits itself (timeout, run-ended and severed-stream errors and their final usage chunk), even after an earlier chunk named a model. It can change within a stream. It is not an OpenRouter model slug, and the request `model` is never used. | | +| `Object` | [components.InternChatCompletionChunkObject](../../models/components/internchatcompletionchunkobject.mdx) | ✅ | N/A | | +| `SessionID` | optionalnullable.OptionalNullable[`string`] | ➖ | On the final chunk of every response, the daemon session to continue with, or `null` when the run failed before the intern reported one. Send it as `session_id` on the next request, including the `tool` reply to an interaction. Session ids are client-visible and scoped to the intern's own daemon. | ses_7f3c9a | +| `Usage` | optionalnullable.OptionalNullable[[components.InternChatUsage](../../models/components/internchatusage.mdx)] | ➖ | Token usage for the run as the daemon reported it, on the final chunk before `[DONE]`. `null` when the daemon reported none, and always `null` after `tool_calls` because the turn is not over. | \{
"completion_tokens": 12,
"prompt_tokens": 40,
"total_tokens": 52
} | \ No newline at end of file diff --git a/docs/models/components/internchatcompletionrequest.mdx b/docs/models/components/internchatcompletionrequest.mdx index 9c38d1be4..6dca3519a 100644 --- a/docs/models/components/internchatcompletionrequest.mdx +++ b/docs/models/components/internchatcompletionrequest.mdx @@ -9,8 +9,8 @@ An OpenAI-compatible streaming chat completion request for one intern. Other Ope | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ApprovalMode` | [*components.InternApprovalMode](../../models/components/internapprovalmode.mdx) | :heavy_minus_sign: | How the run started by this prompt handles tool approvals. `self-drive` (the default when omitted) consents on your behalf and runs the shell unsandboxed. `manual` asks you before an approval-bearing tool runs, as an `openrouter.provide_input` permission request, and keeps the shell sandboxed until an escalation is allowed. The mode applies to the run this prompt starts and is not remembered by the session. Repeat it on each new prompt that should use it. A `tool` reply continues the run under the mode it started with. | manual | -| `Messages` | [][components.InternChatMessage](../../models/components/internchatmessage.mdx) | :heavy_check_mark: | The conversation. Only the last message is read. A last `user` message starts a run. A last `tool` message answers the interaction named by its `tool_call_id` and requires `session_id`. | | -| `Model` | `*string` | :heavy_minus_sign: | Accepted for OpenAI compatibility and never used. The intern runs the model configured on it (`PATCH` the intern to change it). Streamed chunks report the runtime's identifier for that model as the intern reports it, or `openrouter/intern` on chunks whose event carries no model (before the intern reports one, and on the chunks the API emits itself: the timeout, run-ended and severed-stream error chunks, the stop chunk of a replay that ends without a terminal daemon event, and the final usage chunk after any of them). A usage chunk that follows a daemon completion event carries the model the intern reported. | openrouter/intern | -| `SessionID` | `*string` | :heavy_minus_sign: | The daemon session to continue, as returned in `session_id` on the final chunk of an earlier response. Omit it to start a new session. An id the intern has not seen before is not an error: it starts a new session under that id, so a mistyped id forks the conversation. Sessions are scoped to the intern's own daemon. Required when the last message has role `tool`. | ses_7f3c9a | -| `Stream` | `bool` | :heavy_check_mark: | Must be `true`. This endpoint only streams. `false` or an omitted `stream` is refused with `400` and reason `bad_request`. | true | \ No newline at end of file +| `ApprovalMode` | [*components.InternApprovalMode](../../models/components/internapprovalmode.mdx) | ➖ | How the run started by this prompt handles tool approvals. `self-drive` (the default when omitted) consents on your behalf and runs the shell unsandboxed. `manual` asks you before an approval-bearing tool runs, as an `openrouter.provide_input` permission request, and keeps the shell sandboxed until an escalation is allowed. The mode applies to the run this prompt starts and is not remembered by the session. Repeat it on each new prompt that should use it. A `tool` reply continues the run under the mode it started with. | manual | +| `Messages` | [][components.InternChatMessage](../../models/components/internchatmessage.mdx) | ✅ | The conversation. Only the last message is read. A last `user` message starts a run. A last `tool` message answers the interaction named by its `tool_call_id` and requires `session_id`. | | +| `Model` | `*string` | ➖ | Accepted for OpenAI compatibility and never used. The intern runs the model configured on it (`PATCH` the intern to change it). Streamed chunks report the runtime's identifier for that model as the intern reports it, or `openrouter/intern` on chunks whose event carries no model (before the intern reports one, and on the chunks the API emits itself: the timeout, run-ended and severed-stream error chunks, the stop chunk of a replay that ends without a terminal daemon event, and the final usage chunk after any of them). A usage chunk that follows a daemon completion event carries the model the intern reported. | openrouter/intern | +| `SessionID` | `*string` | ➖ | The daemon session to continue, as returned in `session_id` on the final chunk of an earlier response. Omit it to start a new session. An id the intern has not seen before is not an error: it starts a new session under that id, so a mistyped id forks the conversation. Sessions are scoped to the intern's own daemon. Required when the last message has role `tool`. | ses_7f3c9a | +| `Stream` | `bool` | ✅ | Must be `true`. This endpoint only streams. `false` or an omitted `stream` is refused with `400` and reason `bad_request`. | true | \ No newline at end of file diff --git a/docs/models/components/internchatdelta.mdx b/docs/models/components/internchatdelta.mdx index b74777050..986066422 100644 --- a/docs/models/components/internchatdelta.mdx +++ b/docs/models/components/internchatdelta.mdx @@ -9,7 +9,7 @@ The incremental content of one chunk. The first chunk carries `role`, text chunk | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `Content` | `*string` | :heavy_minus_sign: | N/A | -| `Reasoning` | `*string` | :heavy_minus_sign: | N/A | -| `Role` | [*components.InternChatDeltaRole](../../models/components/internchatdeltarole.mdx) | :heavy_minus_sign: | N/A | -| `ToolCalls` | [][components.InternChatToolCall](../../models/components/internchattoolcall.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Content` | `*string` | ➖ | N/A | +| `Reasoning` | `*string` | ➖ | N/A | +| `Role` | [*components.InternChatDeltaRole](../../models/components/internchatdeltarole.mdx) | ➖ | N/A | +| `ToolCalls` | [][components.InternChatToolCall](../../models/components/internchattoolcall.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/internchatdevelopermessage.mdx b/docs/models/components/internchatdevelopermessage.mdx index 183ab668b..95de73992 100644 --- a/docs/models/components/internchatdevelopermessage.mdx +++ b/docs/models/components/internchatdevelopermessage.mdx @@ -9,5 +9,5 @@ A developer message. Accepted for client compatibility and not forwarded. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatDeveloperMessageRole](../../models/components/internchatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatDeveloperMessageRole](../../models/components/internchatdevelopermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatechoedtoolcall.mdx b/docs/models/components/internchatechoedtoolcall.mdx index 2b254f11a..5b8c815e9 100644 --- a/docs/models/components/internchatechoedtoolcall.mdx +++ b/docs/models/components/internchatechoedtoolcall.mdx @@ -9,5 +9,5 @@ The `openrouter.provide_input` tool call from the previous response, echoed back | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Function` | [components.InternChatEchoedToolCallFunction](../../models/components/internchatechoedtoolcallfunction.mdx) | :heavy_check_mark: | The function name and JSON arguments string exactly as streamed. | \{
"arguments": "\{\"kind\":\"permission\",\"operation\":\"shell\",\"options\":[\"allow_once\",\"reject_once\"]}",
"name": "openrouter.provide_input"
} | -| `ID` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Function` | [components.InternChatEchoedToolCallFunction](../../models/components/internchatechoedtoolcallfunction.mdx) | ✅ | The function name and JSON arguments string exactly as streamed. | \{
"arguments": "\{\"kind\":\"permission\",\"operation\":\"shell\",\"options\":[\"allow_once\",\"reject_once\"]}",
"name": "openrouter.provide_input"
} | +| `ID` | `string` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatechoedtoolcallfunction.mdx b/docs/models/components/internchatechoedtoolcallfunction.mdx index f6ab40d5b..60262455b 100644 --- a/docs/models/components/internchatechoedtoolcallfunction.mdx +++ b/docs/models/components/internchatechoedtoolcallfunction.mdx @@ -9,5 +9,5 @@ The function name and JSON arguments string exactly as streamed. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/internchaterror.mdx b/docs/models/components/internchaterror.mdx index b73e6a466..00fadbd21 100644 --- a/docs/models/components/internchaterror.mdx +++ b/docs/models/components/internchaterror.mdx @@ -9,6 +9,6 @@ The OpenAI-compatible error object. `metadata` is present on refusals from the c | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | The HTTP status of the response. | | -| `Message` | `string` | :heavy_check_mark: | N/A | | -| `Metadata` | [*components.InternChatErrorMetadata](../../models/components/internchaterrormetadata.mdx) | :heavy_minus_sign: | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file +| `Code` | `int64` | ✅ | The HTTP status of the response. | | +| `Message` | `string` | ✅ | N/A | | +| `Metadata` | [*components.InternChatErrorMetadata](../../models/components/internchaterrormetadata.mdx) | ➖ | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file diff --git a/docs/models/components/internchaterrormetadata.mdx b/docs/models/components/internchaterrormetadata.mdx index 12f6a72ad..cdc24eeaf 100644 --- a/docs/models/components/internchaterrormetadata.mdx +++ b/docs/models/components/internchaterrormetadata.mdx @@ -9,5 +9,5 @@ Machine-readable detail for the failure. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Reason` | [components.InternChatErrorMetadataReason](../../models/components/internchaterrormetadatareason.mdx) | :heavy_check_mark: | A stable reason a client can branch on. | -| `Retryable` | `bool` | :heavy_check_mark: | Whether the same request may be sent again unchanged. Always `true` for the transient refusals — `busy`, `intern_not_ready`, `intern_unreachable`, `rate_limited`, `stream_severed` and `timeout` — and always `false` for the ones a retry cannot fix. For `turn_failed` it varies by failure and is the intern's own classification of what went wrong: `true` for an upstream overload, rate limit, timeout or transport fault, `false` for an authentication or bad-request failure that would be rejected the same way again. Branch on this field rather than on `reason` when deciding whether to retry. A `429`, and a `409` or `503` with reason `busy`, also carry a `Retry-After` header saying how long to wait. | \ No newline at end of file +| `Reason` | [components.InternChatErrorMetadataReason](../../models/components/internchaterrormetadatareason.mdx) | ✅ | A stable reason a client can branch on. | +| `Retryable` | `bool` | ✅ | Whether the same request may be sent again unchanged. Always `true` for the transient refusals — `busy`, `intern_not_ready`, `intern_unreachable`, `rate_limited`, `stream_severed` and `timeout` — and always `false` for the ones a retry cannot fix. For `turn_failed` it varies by failure and is the intern's own classification of what went wrong: `true` for an upstream overload, rate limit, timeout or transport fault, `false` for an authentication or bad-request failure that would be rejected the same way again. Branch on this field rather than on `reason` when deciding whether to retry. A `429`, and a `409` or `503` with reason `busy`, also carry a `Retry-After` header saying how long to wait. | \ No newline at end of file diff --git a/docs/models/components/internchatprompttokensdetails.mdx b/docs/models/components/internchatprompttokensdetails.mdx index 681587878..0dc3e9568 100644 --- a/docs/models/components/internchatprompttokensdetails.mdx +++ b/docs/models/components/internchatprompttokensdetails.mdx @@ -9,4 +9,4 @@ Prompt tokens served from cache, when the daemon reported them. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `CachedTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `CachedTokens` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/internchatsteeredresponse.mdx b/docs/models/components/internchatsteeredresponse.mdx index 506e62b4d..2b13fca49 100644 --- a/docs/models/components/internchatsteeredresponse.mdx +++ b/docs/models/components/internchatsteeredresponse.mdx @@ -9,5 +9,5 @@ The message was delivered into the turn already running on the same session. Its | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `SessionID` | `string` | :heavy_check_mark: | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | -| `Status` | [components.InternChatSteeredResponseStatus](../../models/components/internchatsteeredresponsestatus.mdx) | :heavy_check_mark: | The message was handed to the turn already running on this session. | | \ No newline at end of file +| `SessionID` | `string` | ✅ | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | +| `Status` | [components.InternChatSteeredResponseStatus](../../models/components/internchatsteeredresponsestatus.mdx) | ✅ | The message was handed to the turn already running on this session. | | \ No newline at end of file diff --git a/docs/models/components/internchatstreamerror.mdx b/docs/models/components/internchatstreamerror.mdx index 35cd71166..14c60e0c9 100644 --- a/docs/models/components/internchatstreamerror.mdx +++ b/docs/models/components/internchatstreamerror.mdx @@ -9,6 +9,6 @@ A failure after the response headers were sent. The chunk that carries it has `f | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | The HTTP status this failure would have had before the stream opened. | | -| `Message` | `string` | :heavy_check_mark: | N/A | | -| `Metadata` | [components.InternChatErrorMetadata](../../models/components/internchaterrormetadata.mdx) | :heavy_check_mark: | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file +| `Code` | `int64` | ✅ | The HTTP status this failure would have had before the stream opened. | | +| `Message` | `string` | ✅ | N/A | | +| `Metadata` | [components.InternChatErrorMetadata](../../models/components/internchaterrormetadata.mdx) | ✅ | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file diff --git a/docs/models/components/internchatstreamingresponse.mdx b/docs/models/components/internchatstreamingresponse.mdx index 2b7d37d8a..8cbc551c8 100644 --- a/docs/models/components/internchatstreamingresponse.mdx +++ b/docs/models/components/internchatstreamingresponse.mdx @@ -9,4 +9,4 @@ A server-sent event carrying one chunk. The stream ends with `data: [DONE]`. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.InternChatCompletionChunk](../../models/components/internchatcompletionchunk.mdx) | :heavy_check_mark: | One `data:` line of the stream. A run streams a role chunk, content and reasoning chunks, then a finish chunk: `stop`, `tool_calls` (the run is paused for input) or `error` (with an `error` object). A final chunk with empty `choices` follows in every case, carrying `session_id` and `usage` (`null` unless the daemon reported usage, and always `null` after `tool_calls`). Every stream ends with `[DONE]`. | \{
"choices": [
\{
"delta": \{
"content": "Hello"
},
"finish_reason": null,
"index": 0
}
],
"created": 1789537541,
"id": "chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750",
"model": "openrouter/intern",
"object": "chat.completion.chunk"
} | \ No newline at end of file +| `Data` | [components.InternChatCompletionChunk](../../models/components/internchatcompletionchunk.mdx) | ✅ | One `data:` line of the stream. A run streams a role chunk, content and reasoning chunks, then a finish chunk: `stop`, `tool_calls` (the run is paused for input) or `error` (with an `error` object). A final chunk with empty `choices` follows in every case, carrying `session_id` and `usage` (`null` unless the daemon reported usage, and always `null` after `tool_calls`). Every stream ends with `[DONE]`. | \{
"choices": [
\{
"delta": \{
"content": "Hello"
},
"finish_reason": null,
"index": 0
}
],
"created": 1789537541,
"id": "chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750",
"model": "openrouter/intern",
"object": "chat.completion.chunk"
} | \ No newline at end of file diff --git a/docs/models/components/internchatsystemmessage.mdx b/docs/models/components/internchatsystemmessage.mdx index 3f205342c..da557ec4c 100644 --- a/docs/models/components/internchatsystemmessage.mdx +++ b/docs/models/components/internchatsystemmessage.mdx @@ -9,5 +9,5 @@ A system message. Accepted for client compatibility and not forwarded. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatSystemMessageRole](../../models/components/internchatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatSystemMessageRole](../../models/components/internchatsystemmessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchattextpart.mdx b/docs/models/components/internchattextpart.mdx index e2e867c9e..438c3b0d8 100644 --- a/docs/models/components/internchattextpart.mdx +++ b/docs/models/components/internchattextpart.mdx @@ -9,5 +9,5 @@ One text part of a message. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.InternChatTextPartType](../../models/components/internchattextparttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.InternChatTextPartType](../../models/components/internchattextparttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/internchattoolcall.mdx b/docs/models/components/internchattoolcall.mdx index f66825e7d..e10a27058 100644 --- a/docs/models/components/internchattoolcall.mdx +++ b/docs/models/components/internchattoolcall.mdx @@ -9,7 +9,7 @@ An `openrouter.provide_input` request. The run pauses on the daemon until a `too | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Function` | [components.InternChatToolCallFunction](../../models/components/internchattoolcallfunction.mdx) | :heavy_check_mark: | The single tool this endpoint calls, asking the caller for input. | \{
"arguments": "\{\"fields\":[\{\"name\":\"answer\",\"options\":[\"red\",\"blue\",\"Other\"],\"required\":true,\"type\":\"string\"}],\"kind\":\"elicitation\",\"message\":\"Which colour do you prefer?\"}",
"name": "openrouter.provide_input"
} | -| `ID` | `string` | :heavy_check_mark: | The interaction id. Send it back as `tool_call_id` on the `tool` message that answers it. | 15e90ad6-5320-4a59-af4f-b371428154fa | -| `Index` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.InternChatToolCallType](../../models/components/internchattoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Function` | [components.InternChatToolCallFunction](../../models/components/internchattoolcallfunction.mdx) | ✅ | The single tool this endpoint calls, asking the caller for input. | \{
"arguments": "\{\"fields\":[\{\"name\":\"answer\",\"options\":[\"red\",\"blue\",\"Other\"],\"required\":true,\"type\":\"string\"}],\"kind\":\"elicitation\",\"message\":\"Which colour do you prefer?\"}",
"name": "openrouter.provide_input"
} | +| `ID` | `string` | ✅ | The interaction id. Send it back as `tool_call_id` on the `tool` message that answers it. | 15e90ad6-5320-4a59-af4f-b371428154fa | +| `Index` | `int64` | ✅ | N/A | | +| `Type` | [components.InternChatToolCallType](../../models/components/internchattoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchattoolcallfunction.mdx b/docs/models/components/internchattoolcallfunction.mdx index 8e744a96c..fce692e58 100644 --- a/docs/models/components/internchattoolcallfunction.mdx +++ b/docs/models/components/internchattoolcallfunction.mdx @@ -9,5 +9,5 @@ The single tool this endpoint calls, asking the caller for input. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | A JSON object string describing the interaction. A permission request is `{"kind":"permission","operation":,"options":[]}`. A question is `{"kind":"elicitation","message":,"fields":[]}`. | \{"fields":[\{"name":"answer","options":["red","blue","Other"],"required":true,"type":"string"}],"kind":"elicitation","message":"Which colour do you prefer?"} | -| `Name` | [components.InternChatToolCallFunctionName](../../models/components/internchattoolcallfunctionname.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | `string` | ✅ | A JSON object string describing the interaction. A permission request is `{"kind":"permission","operation":,"options":[]}`. A question is `{"kind":"elicitation","message":,"fields":[]}`. | \{"fields":[\{"name":"answer","options":["red","blue","Other"],"required":true,"type":"string"}],"kind":"elicitation","message":"Which colour do you prefer?"} | +| `Name` | [components.InternChatToolCallFunctionName](../../models/components/internchattoolcallfunctionname.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchattoolmessage.mdx b/docs/models/components/internchattoolmessage.mdx index 50f79e2fe..9e6a1e9e9 100644 --- a/docs/models/components/internchattoolmessage.mdx +++ b/docs/models/components/internchattoolmessage.mdx @@ -9,6 +9,6 @@ The answer to an `openrouter.provide_input` tool call. `tool_call_id` is the str | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatToolMessageRole](../../models/components/internchattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `ToolCallID` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatToolMessageRole](../../models/components/internchattoolmessagerole.mdx) | ✅ | N/A | | +| `ToolCallID` | `string` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatusage.mdx b/docs/models/components/internchatusage.mdx index 093de080a..ee3eb3173 100644 --- a/docs/models/components/internchatusage.mdx +++ b/docs/models/components/internchatusage.mdx @@ -9,8 +9,8 @@ Token usage for the run as the daemon reported it, on the final chunk before `[D | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `CompletionTokens` | `int64` | :heavy_check_mark: | N/A | | -| `Cost` | `*float64` | :heavy_minus_sign: | The cost of the run in USD, when the daemon reported one. | | -| `PromptTokens` | `int64` | :heavy_check_mark: | N/A | | -| `PromptTokensDetails` | [*components.InternChatPromptTokensDetails](../../models/components/internchatprompttokensdetails.mdx) | :heavy_minus_sign: | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | -| `TotalTokens` | `int64` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CompletionTokens` | `int64` | ✅ | N/A | | +| `Cost` | `*float64` | ➖ | The cost of the run in USD, when the daemon reported one. | | +| `PromptTokens` | `int64` | ✅ | N/A | | +| `PromptTokensDetails` | [*components.InternChatPromptTokensDetails](../../models/components/internchatprompttokensdetails.mdx) | ➖ | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | +| `TotalTokens` | `int64` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/internchatusermessage.mdx b/docs/models/components/internchatusermessage.mdx index f76615f96..312c5c1a8 100644 --- a/docs/models/components/internchatusermessage.mdx +++ b/docs/models/components/internchatusermessage.mdx @@ -9,5 +9,5 @@ A user message. When it is the last message its text is the prompt for a new run | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `Role` | [components.InternChatUserMessageRole](../../models/components/internchatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Content` | [*components.InternChatMessageContent](../../models/components/internchatmessagecontent.mdx) | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `Role` | [components.InternChatUserMessageRole](../../models/components/internchatusermessagerole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/interndaemonaccess.mdx b/docs/models/components/interndaemonaccess.mdx index bdfb79acc..38f25295d 100644 --- a/docs/models/components/interndaemonaccess.mdx +++ b/docs/models/components/interndaemonaccess.mdx @@ -9,5 +9,5 @@ The intern daemon's origin and the bearer `ori tui --host` sends to it as `ORI_D | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Origin` | `string` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Origin` | `string` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/interninvokeacceptedresponse.mdx b/docs/models/components/interninvokeacceptedresponse.mdx index f8b0aa688..9dfccef39 100644 --- a/docs/models/components/interninvokeacceptedresponse.mdx +++ b/docs/models/components/interninvokeacceptedresponse.mdx @@ -9,5 +9,5 @@ The intern admitted the prompt. The run continues on the intern. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `SessionID` | `string` | :heavy_check_mark: | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | -| `Status` | [components.InternInvokeAcceptedResponseStatus](../../models/components/interninvokeacceptedresponsestatus.mdx) | :heavy_check_mark: | `started` when a new run began. `steered` when the session already had a run going and the prompt was delivered into it instead. | started | \ No newline at end of file +| `SessionID` | `string` | ✅ | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | +| `Status` | [components.InternInvokeAcceptedResponseStatus](../../models/components/interninvokeacceptedresponsestatus.mdx) | ✅ | `started` when a new run began. `steered` when the session already had a run going and the prompt was delivered into it instead. | started | \ No newline at end of file diff --git a/docs/models/components/interninvokerequest.mdx b/docs/models/components/interninvokerequest.mdx index 41ce15005..6ae916f9e 100644 --- a/docs/models/components/interninvokerequest.mdx +++ b/docs/models/components/interninvokerequest.mdx @@ -9,5 +9,5 @@ A prompt to run on the intern without holding a connection open. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Input` | `string` | :heavy_check_mark: | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | -| `SessionID` | `*string` | :heavy_minus_sign: | The session to run in. Send the `session_id` from an earlier `202` to continue that conversation, for example to hand the intern a decision on a case it is working. Omit it to start a new session. Only a `session_id` this endpoint issued to the same caller on the same intern is accepted; any other is refused with `404`. | b51a0e21-368b-4780-a220-14655bf28c55 | \ No newline at end of file +| `Input` | `string` | ✅ | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | +| `SessionID` | `*string` | ➖ | The session to run in. Send the `session_id` from an earlier `202` to continue that conversation, for example to hand the intern a decision on a case it is working. Omit it to start a new session. Only a `session_id` this endpoint issued to the same caller on the same intern is accepted; any other is refused with `404`. | b51a0e21-368b-4780-a220-14655bf28c55 | \ No newline at end of file diff --git a/docs/models/components/internlifecycleerrorerror.mdx b/docs/models/components/internlifecycleerrorerror.mdx index 5007be038..8b52aca5d 100644 --- a/docs/models/components/internlifecycleerrorerror.mdx +++ b/docs/models/components/internlifecycleerrorerror.mdx @@ -6,6 +6,6 @@ title: "InternLifecycleErrorError" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Code` | [components.Code](../../models/components/code.mdx) | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | [*components.InternLifecycleErrorMetadata](../../models/components/internlifecycleerrormetadata.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | [components.Code](../../models/components/code.mdx) | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | [*components.InternLifecycleErrorMetadata](../../models/components/internlifecycleerrormetadata.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/internlifecycleerrormetadata.mdx b/docs/models/components/internlifecycleerrormetadata.mdx index f62c41b9c..f4f92c755 100644 --- a/docs/models/components/internlifecycleerrormetadata.mdx +++ b/docs/models/components/internlifecycleerrormetadata.mdx @@ -6,5 +6,5 @@ title: "InternLifecycleErrorMetadata" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Reason` | `string` | :heavy_check_mark: | N/A | -| `Retryable` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Reason` | `string` | ✅ | N/A | +| `Retryable` | `bool` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/internlistresponse.mdx b/docs/models/components/internlistresponse.mdx index 5b8d261a0..1f722dadd 100644 --- a/docs/models/components/internlistresponse.mdx +++ b/docs/models/components/internlistresponse.mdx @@ -9,6 +9,6 @@ Interns visible to the authenticated API key. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Data` | [][components.Intern](../../models/components/intern.mdx) | :heavy_check_mark: | N/A | | -| `HasMore` | `bool` | :heavy_check_mark: | True when more interns match the current filters. | | -| `NextCursor` | `*string` | :heavy_minus_sign: | Opaque cursor, present when `has_more` is true. Pass it as `starting_after` to fetch the next page. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | \ No newline at end of file +| `Data` | [][components.Intern](../../models/components/intern.mdx) | ✅ | N/A | | +| `HasMore` | `bool` | ✅ | True when more interns match the current filters. | | +| `NextCursor` | `*string` | ➖ | Opaque cursor, present when `has_more` is true. Pass it as `starting_after` to fetch the next page. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | \ No newline at end of file diff --git a/docs/models/components/itemreferenceitem.mdx b/docs/models/components/itemreferenceitem.mdx index 8f066bd2f..2afb482f6 100644 --- a/docs/models/components/itemreferenceitem.mdx +++ b/docs/models/components/itemreferenceitem.mdx @@ -9,5 +9,5 @@ A reference to a previous response item by ID | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ItemReferenceItemType](../../models/components/itemreferenceitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | +| `Type` | [components.ItemReferenceItemType](../../models/components/itemreferenceitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/jevrouterplugin.mdx b/docs/models/components/jevrouterplugin.mdx index da7aee03d..334c7b027 100644 --- a/docs/models/components/jevrouterplugin.mdx +++ b/docs/models/components/jevrouterplugin.mdx @@ -6,8 +6,8 @@ title: "JevRouterPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | []`string` | :heavy_minus_sign: | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | -| `CostTier` | `*string` | :heavy_minus_sign: | Select low, medium, high, or a cost tier configured by the operator. Overrides the live-config tier and replaces the shared routing policy with that tier. Omit to use the live configuration. Model exclusions and the router kill switch still apply. | medium | -| `ExcludedModels` | []`string` | :heavy_minus_sign: | Remove these models from the router. Each entry is a model slug or a wildcard pattern (e.g. "xiaomi/*"). A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after `models`, so an excluded pattern always wins over an included one; when the lists leave no model the request can use, it fails with 404 rather than routing outside them. | [
"openai/gpt-6-astra",
"xiaomi/*"
] | -| `ID` | [components.JevRouterPluginID](../../models/components/jevrouterpluginid.mdx) | :heavy_check_mark: | N/A | | -| `Models` | []`string` | :heavy_minus_sign: | Restrict the router to these models. Each entry is a model slug or a wildcard pattern (e.g. "anthropic/*"), matched against the current pool; models outside the pool are ignored. A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When omitted or empty, every model in the pool is a candidate; when no pool model matches, the list is ignored and the whole pool is used (`excluded_models` still apply). `allowed_models` is an alias; entries from both fields are combined. | [
"anthropic/*",
"openai/gpt-5.6-sol"
] | \ No newline at end of file +| `AllowedModels` | []`string` | ➖ | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | +| `CostTier` | `*string` | ➖ | Select low, medium, high, or a cost tier configured by the operator. Overrides the live-config tier and replaces the shared routing policy with that tier. Omit to use the live configuration. Model exclusions and the router kill switch still apply. | medium | +| `ExcludedModels` | []`string` | ➖ | Remove these models from the router. Each entry is a model slug or a wildcard pattern (e.g. "xiaomi/*"). A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after `models`, so an excluded pattern always wins over an included one; when the lists leave no model the request can use, it fails with 404 rather than routing outside them. | [
"openai/gpt-6-astra",
"xiaomi/*"
] | +| `ID` | [components.JevRouterPluginID](../../models/components/jevrouterpluginid.mdx) | ✅ | N/A | | +| `Models` | []`string` | ➖ | Restrict the router to these models. Each entry is a model slug or a wildcard pattern (e.g. "anthropic/*"), matched against the current pool; models outside the pool are ignored. A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When omitted or empty, every model in the pool is a candidate; when no pool model matches, the list is ignored and the whole pool is used (`excluded_models` still apply). `allowed_models` is an alias; entries from both fields are combined. | [
"anthropic/*",
"openai/gpt-5.6-sol"
] | \ No newline at end of file diff --git a/docs/models/components/keepall.mdx b/docs/models/components/keepall.mdx index ae5186c84..cfd2cada7 100644 --- a/docs/models/components/keepall.mdx +++ b/docs/models/components/keepall.mdx @@ -6,4 +6,4 @@ title: "KeepAll" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Type` | [components.KeepType](../../models/components/keeptype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.KeepType](../../models/components/keeptype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/key.mdx b/docs/models/components/key.mdx index 30db612e1..17f64d5ab 100644 --- a/docs/models/components/key.mdx +++ b/docs/models/components/key.mdx @@ -6,10 +6,10 @@ title: "Key" | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `Alg` | [components.Alg](../../models/components/alg.mdx) | :heavy_check_mark: | N/A | -| `Crv` | [components.Crv](../../models/components/crv.mdx) | :heavy_check_mark: | N/A | -| `Kid` | `string` | :heavy_check_mark: | N/A | -| `Kty` | [components.Kty](../../models/components/kty.mdx) | :heavy_check_mark: | N/A | -| `Use` | [components.Use](../../models/components/use.mdx) | :heavy_check_mark: | N/A | -| `X` | `string` | :heavy_check_mark: | N/A | -| `Y` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Alg` | [components.Alg](../../models/components/alg.mdx) | ✅ | N/A | +| `Crv` | [components.Crv](../../models/components/crv.mdx) | ✅ | N/A | +| `Kid` | `string` | ✅ | N/A | +| `Kty` | [components.Kty](../../models/components/kty.mdx) | ✅ | N/A | +| `Use` | [components.Use](../../models/components/use.mdx) | ✅ | N/A | +| `X` | `string` | ✅ | N/A | +| `Y` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/keyassignment.mdx b/docs/models/components/keyassignment.mdx index 2c43bdd78..53549ef05 100644 --- a/docs/models/components/keyassignment.mdx +++ b/docs/models/components/keyassignment.mdx @@ -6,10 +6,10 @@ title: "KeyAssignment" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `AssignedBy` | `*string` | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `GuardrailID` | `string` | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `KeyHash` | `string` | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `KeyLabel` | `string` | :heavy_check_mark: | Label of the API key | prod-key | -| `KeyName` | `string` | :heavy_check_mark: | Name of the API key | Production Key | \ No newline at end of file +| `AssignedBy` | `*string` | ✅ | User ID of who made the assignment | user_abc123 | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `GuardrailID` | `string` | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `ID` | `string` | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `KeyHash` | `string` | ✅ | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | +| `KeyLabel` | `string` | ✅ | Label of the API key | prod-key | +| `KeyName` | `string` | ✅ | Name of the API key | Production Key | \ No newline at end of file diff --git a/docs/models/components/legacychatcontentvideo.mdx b/docs/models/components/legacychatcontentvideo.mdx index 424b46635..b86f41be0 100644 --- a/docs/models/components/legacychatcontentvideo.mdx +++ b/docs/models/components/legacychatcontentvideo.mdx @@ -4,12 +4,12 @@ title: "~~LegacyChatContentVideo~~" Video input content part (legacy format - deprecated) -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Fields | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Type` | [components.LegacyChatContentVideoType](../../models/components/legacychatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | -| `VideoURL` | [components.LegacyChatContentVideoInput](../../models/components/legacychatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `Type` | [components.LegacyChatContentVideoType](../../models/components/legacychatcontentvideotype.mdx) | ✅ | N/A | | +| `VideoURL` | [components.LegacyChatContentVideoInput](../../models/components/legacychatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/components/legacychatcontentvideoinput.mdx b/docs/models/components/legacychatcontentvideoinput.mdx index 89b253bb0..30ee33d08 100644 --- a/docs/models/components/legacychatcontentvideoinput.mdx +++ b/docs/models/components/legacychatcontentvideoinput.mdx @@ -9,5 +9,5 @@ Video input object | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Processing` | [*components.LegacyChatContentVideoInputProcessing](../../models/components/legacychatcontentvideoinputprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `URL` | `string` | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file +| `Processing` | [*components.LegacyChatContentVideoInputProcessing](../../models/components/legacychatcontentvideoinputprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `URL` | `string` | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/models/components/legacywebsearchservertool.mdx b/docs/models/components/legacywebsearchservertool.mdx index 2550a3111..dd619fb53 100644 --- a/docs/models/components/legacywebsearchservertool.mdx +++ b/docs/models/components/legacywebsearchservertool.mdx @@ -9,12 +9,12 @@ Web search tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.LegacyWebSearchServerToolType](../../models/components/legacywebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `Type` | [components.LegacyWebSearchServerToolType](../../models/components/legacywebsearchservertooltype.mdx) | ✅ | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/listbyokkeysresponse.mdx b/docs/models/components/listbyokkeysresponse.mdx index 78aefe26f..a42c2d555 100644 --- a/docs/models/components/listbyokkeysresponse.mdx +++ b/docs/models/components/listbyokkeysresponse.mdx @@ -6,5 +6,5 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Data` | [][components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | List of BYOK credentials. | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file +| `Data` | [][components.BYOKKey](../../models/components/byokkey.mdx) | ✅ | List of BYOK credentials. | | +| `TotalCount` | `int64` | ✅ | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/components/listendpointsresponse.mdx b/docs/models/components/listendpointsresponse.mdx index 795ee2f8f..a1301eb32 100644 --- a/docs/models/components/listendpointsresponse.mdx +++ b/docs/models/components/listendpointsresponse.mdx @@ -9,9 +9,9 @@ List of available endpoints for a model | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Architecture` | [components.Architecture](../../models/components/architecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `Description` | `string` | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `Endpoints` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | :heavy_check_mark: | List of available endpoints for this model | | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `Name` | `string` | :heavy_check_mark: | Display name of the model | GPT-4 | \ No newline at end of file +| `Architecture` | [components.Architecture](../../models/components/architecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `Created` | `int64` | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `Description` | `string` | ✅ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `Endpoints` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | ✅ | List of available endpoints for this model | | +| `ID` | `string` | ✅ | Unique identifier for the model | openai/gpt-4 | +| `Name` | `string` | ✅ | Display name of the model | GPT-4 | \ No newline at end of file diff --git a/docs/models/components/listendusersresponse.mdx b/docs/models/components/listendusersresponse.mdx index 9d843e5ae..fe5438327 100644 --- a/docs/models/components/listendusersresponse.mdx +++ b/docs/models/components/listendusersresponse.mdx @@ -6,5 +6,5 @@ title: "ListEndUsersResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Data` | [][components.EndUser](../../models/components/enduser.mdx) | :heavy_check_mark: | N/A | | -| `TotalCount` | `int64` | :heavy_check_mark: | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file +| `Data` | [][components.EndUser](../../models/components/enduser.mdx) | ✅ | N/A | | +| `TotalCount` | `int64` | ✅ | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file diff --git a/docs/models/components/listguardrailsresponse.mdx b/docs/models/components/listguardrailsresponse.mdx index f8330d492..3a58d9243 100644 --- a/docs/models/components/listguardrailsresponse.mdx +++ b/docs/models/components/listguardrailsresponse.mdx @@ -6,5 +6,5 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | List of guardrails | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file +| `Data` | [][components.Guardrail](../../models/components/guardrail.mdx) | ✅ | List of guardrails | | +| `TotalCount` | `int64` | ✅ | Total number of guardrails | 25 | \ No newline at end of file diff --git a/docs/models/components/listkeyassignmentsresponse.mdx b/docs/models/components/listkeyassignmentsresponse.mdx index 50b790255..a87334632 100644 --- a/docs/models/components/listkeyassignmentsresponse.mdx +++ b/docs/models/components/listkeyassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Data` | [][components.KeyAssignment](../../models/components/keyassignment.mdx) | :heavy_check_mark: | List of key assignments | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file +| `Data` | [][components.KeyAssignment](../../models/components/keyassignment.mdx) | ✅ | List of key assignments | | +| `TotalCount` | `int64` | ✅ | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/docs/models/components/listmemberassignmentsresponse.mdx b/docs/models/components/listmemberassignmentsresponse.mdx index 47f80b073..7d426f679 100644 --- a/docs/models/components/listmemberassignmentsresponse.mdx +++ b/docs/models/components/listmemberassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Data` | [][components.MemberAssignment](../../models/components/memberassignment.mdx) | :heavy_check_mark: | List of member assignments | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file +| `Data` | [][components.MemberAssignment](../../models/components/memberassignment.mdx) | ✅ | List of member assignments | | +| `TotalCount` | `int64` | ✅ | Total number of member assignments | 10 | \ No newline at end of file diff --git a/docs/models/components/listobservabilitydestinationsresponse.mdx b/docs/models/components/listobservabilitydestinationsresponse.mdx index 0271143fe..29da8a3b4 100644 --- a/docs/models/components/listobservabilitydestinationsresponse.mdx +++ b/docs/models/components/listobservabilitydestinationsresponse.mdx @@ -6,5 +6,5 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Data` | [][components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | List of observability destinations. | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of destinations matching the filters. | 1 | \ No newline at end of file +| `Data` | [][components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | ✅ | List of observability destinations. | | +| `TotalCount` | `int64` | ✅ | Total number of destinations matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/components/listpresetsresponse.mdx b/docs/models/components/listpresetsresponse.mdx index 1b67ede4d..eb5391e59 100644 --- a/docs/models/components/listpresetsresponse.mdx +++ b/docs/models/components/listpresetsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of presets. | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Data` | [][components.Preset](../../models/components/preset.mdx) | :heavy_check_mark: | N/A | -| `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.Preset](../../models/components/preset.mdx) | ✅ | N/A | +| `TotalCount` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/listpresetversionsresponse.mdx b/docs/models/components/listpresetversionsresponse.mdx index 625b2bbd6..93e14a0e6 100644 --- a/docs/models/components/listpresetversionsresponse.mdx +++ b/docs/models/components/listpresetversionsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of preset versions. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Data` | [][*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | :heavy_check_mark: | N/A | -| `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | ✅ | N/A | +| `TotalCount` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/listprivateendpointsresponse.mdx b/docs/models/components/listprivateendpointsresponse.mdx index 618511e93..41e3794fd 100644 --- a/docs/models/components/listprivateendpointsresponse.mdx +++ b/docs/models/components/listprivateendpointsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPrivateEndpointsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Data` | [][components.PrivateEndpointSummary](../../models/components/privateendpointsummary.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.PrivateEndpointSummary](../../models/components/privateendpointsummary.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/listscimgroupmappingsresponse.mdx b/docs/models/components/listscimgroupmappingsresponse.mdx index 5c722d196..0d981f84d 100644 --- a/docs/models/components/listscimgroupmappingsresponse.mdx +++ b/docs/models/components/listscimgroupmappingsresponse.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupMappingsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Data` | [][components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | -| `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | ✅ | N/A | +| `TotalCount` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/listscimgroupsresponse.mdx b/docs/models/components/listscimgroupsresponse.mdx index 003a65257..f7954a0f7 100644 --- a/docs/models/components/listscimgroupsresponse.mdx +++ b/docs/models/components/listscimgroupsresponse.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupsResponse" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.ScimGroup](../../models/components/scimgroup.mdx) | :heavy_check_mark: | N/A | -| `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.ScimGroup](../../models/components/scimgroup.mdx) | ✅ | N/A | +| `TotalCount` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/listtoolsresponse.mdx b/docs/models/components/listtoolsresponse.mdx index d420c9693..f62cdff65 100644 --- a/docs/models/components/listtoolsresponse.mdx +++ b/docs/models/components/listtoolsresponse.mdx @@ -6,6 +6,6 @@ title: "ListToolsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [][components.ServerTool](../../models/components/servertool.mdx) | :heavy_check_mark: | N/A | | -| `Links` | [components.ListToolsResponseLinks](../../models/components/listtoolsresponselinks.mdx) | :heavy_check_mark: | N/A | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of tools | 12 | \ No newline at end of file +| `Data` | [][components.ServerTool](../../models/components/servertool.mdx) | ✅ | N/A | | +| `Links` | [components.ListToolsResponseLinks](../../models/components/listtoolsresponselinks.mdx) | ✅ | N/A | | +| `TotalCount` | `int64` | ✅ | Total number of tools | 12 | \ No newline at end of file diff --git a/docs/models/components/listtoolsresponselinks.mdx b/docs/models/components/listtoolsresponselinks.mdx index 20891cf29..77e0f0827 100644 --- a/docs/models/components/listtoolsresponselinks.mdx +++ b/docs/models/components/listtoolsresponselinks.mdx @@ -6,4 +6,4 @@ title: "ListToolsResponseLinks" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Next` | `*string` | :heavy_check_mark: | URL for the next page of results, or null if this is the last page | null | \ No newline at end of file +| `Next` | `*string` | ✅ | URL for the next page of results, or null if this is the last page | null | \ No newline at end of file diff --git a/docs/models/components/listworkspacebudgetsresponse.mdx b/docs/models/components/listworkspacebudgetsresponse.mdx index b597bca5d..93ae8c72b 100644 --- a/docs/models/components/listworkspacebudgetsresponse.mdx +++ b/docs/models/components/listworkspacebudgetsresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceBudgetsResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | :heavy_check_mark: | List of budgets configured for the workspace | | -| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | false | \ No newline at end of file +| `Data` | [][components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | ✅ | List of budgets configured for the workspace | | +| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | false | \ No newline at end of file diff --git a/docs/models/components/listworkspacemembersresponse.mdx b/docs/models/components/listworkspacemembersresponse.mdx index 101bed62a..e1422ed16 100644 --- a/docs/models/components/listworkspacemembersresponse.mdx +++ b/docs/models/components/listworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | :heavy_check_mark: | List of workspace members | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of members in the workspace | 5 | \ No newline at end of file +| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | ✅ | List of workspace members | | +| `TotalCount` | `int64` | ✅ | Total number of members in the workspace | 5 | \ No newline at end of file diff --git a/docs/models/components/listworkspacesresponse.mdx b/docs/models/components/listworkspacesresponse.mdx index 8c5ee5bbc..a20e39412 100644 --- a/docs/models/components/listworkspacesresponse.mdx +++ b/docs/models/components/listworkspacesresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | List of workspaces | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file +| `Data` | [][components.Workspace](../../models/components/workspace.mdx) | ✅ | List of workspaces | | +| `TotalCount` | `int64` | ✅ | Total number of workspaces | 5 | \ No newline at end of file diff --git a/docs/models/components/localshellcallitem.mdx b/docs/models/components/localshellcallitem.mdx index 7f2394870..a33416e57 100644 --- a/docs/models/components/localshellcallitem.mdx +++ b/docs/models/components/localshellcallitem.mdx @@ -9,8 +9,8 @@ A local shell command execution call | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Action` | [components.LocalShellCallItemAction](../../models/components/localshellcallitemaction.mdx) | :heavy_check_mark: | N/A | | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.TypeLocalShellCall](../../models/components/typelocalshellcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Action` | [components.LocalShellCallItemAction](../../models/components/localshellcallitemaction.mdx) | ✅ | N/A | | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.TypeLocalShellCall](../../models/components/typelocalshellcall.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/localshellcallitemaction.mdx b/docs/models/components/localshellcallitemaction.mdx index b78a3a789..81e27326f 100644 --- a/docs/models/components/localshellcallitemaction.mdx +++ b/docs/models/components/localshellcallitemaction.mdx @@ -6,9 +6,9 @@ title: "LocalShellCallItemAction" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Command` | []`string` | :heavy_check_mark: | N/A | -| `Env` | map[string]`string` | :heavy_check_mark: | N/A | -| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeExec](../../models/components/typeexec.mdx) | :heavy_check_mark: | N/A | -| `User` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `WorkingDirectory` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Command` | []`string` | ✅ | N/A | +| `Env` | map[string]`string` | ✅ | N/A | +| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | +| `Type` | [components.TypeExec](../../models/components/typeexec.mdx) | ✅ | N/A | +| `User` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `WorkingDirectory` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/localshellcalloutputitem.mdx b/docs/models/components/localshellcalloutputitem.mdx index 14d681671..742c4e674 100644 --- a/docs/models/components/localshellcalloutputitem.mdx +++ b/docs/models/components/localshellcalloutputitem.mdx @@ -9,7 +9,7 @@ Output from a local shell command execution | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Output` | `string` | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.LocalShellCallOutputItemType](../../models/components/localshellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | | +| `Output` | `string` | ✅ | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | +| `Type` | [components.LocalShellCallOutputItemType](../../models/components/localshellcalloutputitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/logprob.mdx b/docs/models/components/logprob.mdx index 94c343768..f7f753d42 100644 --- a/docs/models/components/logprob.mdx +++ b/docs/models/components/logprob.mdx @@ -6,7 +6,7 @@ title: "Logprob" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | -| `TopLogprobs` | [][components.ResponseOutputTextTopLogprob](../../models/components/responseoutputtexttoplogprob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ✅ | N/A | +| `Logprob` | `float64` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | +| `TopLogprobs` | [][components.ResponseOutputTextTopLogprob](../../models/components/responseoutputtexttoplogprob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/logprobs.mdx b/docs/models/components/logprobs.mdx index 7469b0c6a..d21a081c7 100644 --- a/docs/models/components/logprobs.mdx +++ b/docs/models/components/logprobs.mdx @@ -6,5 +6,5 @@ title: "Logprobs" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Content` | [][components.LogprobsContent](../../models/components/logprobscontent.mdx) | :heavy_check_mark: | N/A | -| `Refusal` | optionalnullable.OptionalNullable[[][components.Refusal](../../models/components/refusal.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Content` | [][components.LogprobsContent](../../models/components/logprobscontent.mdx) | ✅ | N/A | +| `Refusal` | optionalnullable.OptionalNullable[[][components.Refusal](../../models/components/refusal.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/logprobscontent.mdx b/docs/models/components/logprobscontent.mdx index cd0be419d..8d63b0efb 100644 --- a/docs/models/components/logprobscontent.mdx +++ b/docs/models/components/logprobscontent.mdx @@ -6,7 +6,7 @@ title: "LogprobsContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | -| `TopLogprobs` | [][components.ContentTopLogprob](../../models/components/contenttoplogprob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ✅ | N/A | +| `Logprob` | `float64` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | +| `TopLogprobs` | [][components.ContentTopLogprob](../../models/components/contenttoplogprob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/managedprivateendpoint.mdx b/docs/models/components/managedprivateendpoint.mdx index e1e30d353..50614a7a8 100644 --- a/docs/models/components/managedprivateendpoint.mdx +++ b/docs/models/components/managedprivateendpoint.mdx @@ -6,12 +6,12 @@ title: "ManagedPrivateEndpoint" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `ModelName` | `*string` | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `ModelSlug` | `*string` | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `ProviderName` | `string` | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | -| `DeclaredRegion` | [*components.PrivateEndpointDeclaredRegion](../../models/components/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `DeclaredZdr` | `*bool` | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `ModelName` | `*string` | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `ModelPermaslug` | `string` | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `ModelSlug` | `*string` | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `ProviderName` | `string` | ✅ | Display name of the upstream provider. | Azure | +| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | +| `DeclaredRegion` | [*components.PrivateEndpointDeclaredRegion](../../models/components/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `DeclaredZdr` | `*bool` | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | \ No newline at end of file diff --git a/docs/models/components/managedprivateendpointresponse.mdx b/docs/models/components/managedprivateendpointresponse.mdx index 2fa5f843d..1c36f6a81 100644 --- a/docs/models/components/managedprivateendpointresponse.mdx +++ b/docs/models/components/managedprivateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "ManagedPrivateEndpointResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.ManagedPrivateEndpoint](../../models/components/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.ManagedPrivateEndpoint](../../models/components/managedprivateendpoint.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/maxprice.mdx b/docs/models/components/maxprice.mdx index b1ed976cd..68e35cb0b 100644 --- a/docs/models/components/maxprice.mdx +++ b/docs/models/components/maxprice.mdx @@ -9,8 +9,8 @@ The object specifying the maximum price you want to pay for this request. USD pr | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Audio` | `*string` | :heavy_minus_sign: | Maximum price in USD per audio unit | -| `Completion` | `*string` | :heavy_minus_sign: | Maximum price in USD per million completion tokens | -| `Image` | `*string` | :heavy_minus_sign: | Maximum price in USD per image | -| `Prompt` | `*string` | :heavy_minus_sign: | Maximum price in USD per million prompt tokens | -| `Request` | `*string` | :heavy_minus_sign: | Maximum price in USD per request | \ No newline at end of file +| `Audio` | `*string` | ➖ | Maximum price in USD per audio unit | +| `Completion` | `*string` | ➖ | Maximum price in USD per million completion tokens | +| `Image` | `*string` | ➖ | Maximum price in USD per image | +| `Prompt` | `*string` | ➖ | Maximum price in USD per million prompt tokens | +| `Request` | `*string` | ➖ | Maximum price in USD per request | \ No newline at end of file diff --git a/docs/models/components/mcpapprovalrequestitem.mdx b/docs/models/components/mcpapprovalrequestitem.mdx index 2bdcd9a2c..0b7f873e4 100644 --- a/docs/models/components/mcpapprovalrequestitem.mdx +++ b/docs/models/components/mcpapprovalrequestitem.mdx @@ -9,8 +9,8 @@ Request for approval to execute an MCP tool | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `ServerLabel` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.McpApprovalRequestItemType](../../models/components/mcpapprovalrequestitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | +| `ServerLabel` | `string` | ✅ | N/A | +| `Type` | [components.McpApprovalRequestItemType](../../models/components/mcpapprovalrequestitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpapprovalresponseitem.mdx b/docs/models/components/mcpapprovalresponseitem.mdx index a8ff8a03a..9abbe874a 100644 --- a/docs/models/components/mcpapprovalresponseitem.mdx +++ b/docs/models/components/mcpapprovalresponseitem.mdx @@ -9,8 +9,8 @@ User response to an MCP tool approval request | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ApprovalRequestID` | `string` | :heavy_check_mark: | N/A | -| `Approve` | `bool` | :heavy_check_mark: | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Reason` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.McpApprovalResponseItemType](../../models/components/mcpapprovalresponseitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ApprovalRequestID` | `string` | ✅ | N/A | +| `Approve` | `bool` | ✅ | N/A | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Reason` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.McpApprovalResponseItemType](../../models/components/mcpapprovalresponseitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpcallitem.mdx b/docs/models/components/mcpcallitem.mdx index 26e4b7414..35139073c 100644 --- a/docs/models/components/mcpcallitem.mdx +++ b/docs/models/components/mcpcallitem.mdx @@ -9,10 +9,10 @@ An MCP tool call with its output or error | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `Error` | optionalnullable.OptionalNullable[[components.McpToolCallError](../../models/components/mcptoolcallerror.mdx)] | :heavy_minus_sign: | Error from an MCP tool call, either a plain message or a structured error | \{
"code": 503,
"message": "Service Unavailable",
"type": "http_error"
} | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Output` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ServerLabel` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.McpCallItemType](../../models/components/mcpcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | | +| `Error` | optionalnullable.OptionalNullable[[components.McpToolCallError](../../models/components/mcptoolcallerror.mdx)] | ➖ | Error from an MCP tool call, either a plain message or a structured error | \{
"code": 503,
"message": "Service Unavailable",
"type": "http_error"
} | +| `ID` | `string` | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Output` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ServerLabel` | `string` | ✅ | N/A | | +| `Type` | [components.McpCallItemType](../../models/components/mcpcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/mcphttperror.mdx b/docs/models/components/mcphttperror.mdx index d7106ac3a..40e695d87 100644 --- a/docs/models/components/mcphttperror.mdx +++ b/docs/models/components/mcphttperror.mdx @@ -9,6 +9,6 @@ The MCP server request failed at the HTTP layer | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.McpHTTPErrorType](../../models/components/mcphttperrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Type` | [components.McpHTTPErrorType](../../models/components/mcphttperrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/mcplisttoolsitem.mdx b/docs/models/components/mcplisttoolsitem.mdx index 3fc1b4f36..3be02ba0f 100644 --- a/docs/models/components/mcplisttoolsitem.mdx +++ b/docs/models/components/mcplisttoolsitem.mdx @@ -9,8 +9,8 @@ List of available MCP tools from a server | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Error` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `ServerLabel` | `string` | :heavy_check_mark: | N/A | -| `Tools` | [][components.McpListToolsItemTool](../../models/components/mcplisttoolsitemtool.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.McpListToolsItemType](../../models/components/mcplisttoolsitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Error` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ID` | `string` | ✅ | N/A | +| `ServerLabel` | `string` | ✅ | N/A | +| `Tools` | [][components.McpListToolsItemTool](../../models/components/mcplisttoolsitemtool.mdx) | ✅ | N/A | +| `Type` | [components.McpListToolsItemType](../../models/components/mcplisttoolsitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/mcplisttoolsitemtool.mdx b/docs/models/components/mcplisttoolsitemtool.mdx index 4aa3e1ff5..5e67faec6 100644 --- a/docs/models/components/mcplisttoolsitemtool.mdx +++ b/docs/models/components/mcplisttoolsitemtool.mdx @@ -6,7 +6,7 @@ title: "McpListToolsItemTool" | Field | Type | Required | Description | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Annotations` | `any` | :heavy_minus_sign: | N/A | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `InputSchema` | map[string]`any` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Annotations` | `any` | ➖ | N/A | +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `InputSchema` | map[string]`any` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpprotocolerror.mdx b/docs/models/components/mcpprotocolerror.mdx index cdcd6dfac..31b359424 100644 --- a/docs/models/components/mcpprotocolerror.mdx +++ b/docs/models/components/mcpprotocolerror.mdx @@ -9,6 +9,6 @@ The MCP server returned a protocol-level error | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.McpProtocolErrorType](../../models/components/mcpprotocolerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Type` | [components.McpProtocolErrorType](../../models/components/mcpprotocolerrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpservertool.mdx b/docs/models/components/mcpservertool.mdx index 087a6cc0e..9dc3bfdc9 100644 --- a/docs/models/components/mcpservertool.mdx +++ b/docs/models/components/mcpservertool.mdx @@ -9,12 +9,12 @@ MCP (Model Context Protocol) tool configuration | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `AllowedTools` | optionalnullable.OptionalNullable[[components.AllowedToolsUnion](../../models/components/allowedtoolsunion.mdx)] | :heavy_minus_sign: | N/A | -| `Authorization` | `*string` | :heavy_minus_sign: | N/A | -| `ConnectorID` | [*components.ConnectorID](../../models/components/connectorid.mdx) | :heavy_minus_sign: | N/A | -| `Headers` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | N/A | -| `RequireApproval` | optionalnullable.OptionalNullable[[components.RequireApprovalUnion](../../models/components/requireapprovalunion.mdx)] | :heavy_minus_sign: | N/A | -| `ServerDescription` | `*string` | :heavy_minus_sign: | N/A | -| `ServerLabel` | `string` | :heavy_check_mark: | N/A | -| `ServerURL` | `*string` | :heavy_minus_sign: | N/A | -| `Type` | [components.McpServerToolType](../../models/components/mcpservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `AllowedTools` | optionalnullable.OptionalNullable[[components.AllowedToolsUnion](../../models/components/allowedtoolsunion.mdx)] | ➖ | N/A | +| `Authorization` | `*string` | ➖ | N/A | +| `ConnectorID` | [*components.ConnectorID](../../models/components/connectorid.mdx) | ➖ | N/A | +| `Headers` | optionalnullable.OptionalNullable[map[string]`string`] | ➖ | N/A | +| `RequireApproval` | optionalnullable.OptionalNullable[[components.RequireApprovalUnion](../../models/components/requireapprovalunion.mdx)] | ➖ | N/A | +| `ServerDescription` | `*string` | ➖ | N/A | +| `ServerLabel` | `string` | ✅ | N/A | +| `ServerURL` | `*string` | ➖ | N/A | +| `Type` | [components.McpServerToolType](../../models/components/mcpservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/mcptoolexecutionerror.mdx b/docs/models/components/mcptoolexecutionerror.mdx index 5998fcb01..db331a5ba 100644 --- a/docs/models/components/mcptoolexecutionerror.mdx +++ b/docs/models/components/mcptoolexecutionerror.mdx @@ -9,5 +9,5 @@ The MCP tool ran but reported a failure | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Content` | `any` | :heavy_minus_sign: | N/A | -| `Type` | [components.McpToolExecutionErrorType](../../models/components/mcptoolexecutionerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | `any` | ➖ | N/A | +| `Type` | [components.McpToolExecutionErrorType](../../models/components/mcptoolexecutionerrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/memberassignment.mdx b/docs/models/components/memberassignment.mdx index baaa31fbb..dac9653a4 100644 --- a/docs/models/components/memberassignment.mdx +++ b/docs/models/components/memberassignment.mdx @@ -6,9 +6,9 @@ title: "MemberAssignment" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `AssignedBy` | `*string` | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `GuardrailID` | `string` | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `OrganizationID` | `string` | :heavy_check_mark: | Organization ID | org_xyz789 | -| `UserID` | `string` | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file +| `AssignedBy` | `*string` | ✅ | User ID of who made the assignment | user_abc123 | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `GuardrailID` | `string` | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `ID` | `string` | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `OrganizationID` | `string` | ✅ | Organization ID | org_xyz789 | +| `UserID` | `string` | ✅ | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file diff --git a/docs/models/components/message.mdx b/docs/models/components/message.mdx index 9d8b0db8f..0dabd27de 100644 --- a/docs/models/components/message.mdx +++ b/docs/models/components/message.mdx @@ -6,11 +6,11 @@ title: "Message" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Annotations` | [][components.Annotation](../../models/components/annotation.mdx) | :heavy_minus_sign: | N/A | -| `Content` | `*string` | :heavy_check_mark: | N/A | -| `Images` | optionalnullable.OptionalNullable[[][components.Image](../../models/components/image.mdx)] | :heavy_minus_sign: | N/A | -| `Reasoning` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ReasoningDetails` | optionalnullable.OptionalNullable[[][*components.ReasoningDetail](../../models/components/reasoningdetail.mdx)] | :heavy_minus_sign: | N/A | -| `Refusal` | `*string` | :heavy_check_mark: | N/A | -| `Role` | [components.ChoiceRole](../../models/components/choicerole.mdx) | :heavy_check_mark: | N/A | -| `ToolCalls` | [][components.ToolCall](../../models/components/toolcall.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Annotations` | [][components.Annotation](../../models/components/annotation.mdx) | ➖ | N/A | +| `Content` | `*string` | ✅ | N/A | +| `Images` | optionalnullable.OptionalNullable[[][components.Image](../../models/components/image.mdx)] | ➖ | N/A | +| `Reasoning` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ReasoningDetails` | optionalnullable.OptionalNullable[[][*components.ReasoningDetail](../../models/components/reasoningdetail.mdx)] | ➖ | N/A | +| `Refusal` | `*string` | ✅ | N/A | +| `Role` | [components.ChoiceRole](../../models/components/choicerole.mdx) | ✅ | N/A | +| `ToolCalls` | [][components.ToolCall](../../models/components/toolcall.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesadvisortoolresultblock.mdx b/docs/models/components/messagesadvisortoolresultblock.mdx index bf05787b4..543f4980e 100644 --- a/docs/models/components/messagesadvisortoolresultblock.mdx +++ b/docs/models/components/messagesadvisortoolresultblock.mdx @@ -9,6 +9,6 @@ Advisor tool result from a prior assistant turn, replayed back to the model on t | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Content` | map[string]`any` | :heavy_check_mark: | N/A | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesAdvisorToolResultBlockType](../../models/components/messagesadvisortoolresultblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | map[string]`any` | ✅ | N/A | +| `ToolUseID` | `string` | ✅ | N/A | +| `Type` | [components.MessagesAdvisorToolResultBlockType](../../models/components/messagesadvisortoolresultblocktype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesbashtoolresultblock.mdx b/docs/models/components/messagesbashtoolresultblock.mdx index d2e51ec9a..f904b759c 100644 --- a/docs/models/components/messagesbashtoolresultblock.mdx +++ b/docs/models/components/messagesbashtoolresultblock.mdx @@ -9,8 +9,8 @@ Output of a sandbox-executed `openrouter:bash` call from a prior assistant turn. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `Content` | map[string]`any` | :heavy_check_mark: | N/A | -| `Files` | [][components.MessagesBashToolResultBlockFile](../../models/components/messagesbashtoolresultblockfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesBashToolResultBlockTypeOpenrouterBashToolResult](../../models/components/messagesbashtoolresultblocktypeopenrouterbashtoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `Content` | map[string]`any` | ✅ | N/A | +| `Files` | [][components.MessagesBashToolResultBlockFile](../../models/components/messagesbashtoolresultblockfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `ToolUseID` | `string` | ✅ | N/A | +| `Type` | [components.MessagesBashToolResultBlockTypeOpenrouterBashToolResult](../../models/components/messagesbashtoolresultblocktypeopenrouterbashtoolresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesbashtoolresultblockfile.mdx b/docs/models/components/messagesbashtoolresultblockfile.mdx index 48cad59a2..54ffdc525 100644 --- a/docs/models/components/messagesbashtoolresultblockfile.mdx +++ b/docs/models/components/messagesbashtoolresultblockfile.mdx @@ -6,9 +6,9 @@ title: "MessagesBashToolResultBlockFile" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesBashToolResultBlockTypeContainerFileCitation](../../models/components/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `string` | ✅ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Type` | [components.MessagesBashToolResultBlockTypeContainerFileCitation](../../models/components/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesfallbackparam.mdx b/docs/models/components/messagesfallbackparam.mdx index 18c5a3182..5329ffcb5 100644 --- a/docs/models/components/messagesfallbackparam.mdx +++ b/docs/models/components/messagesfallbackparam.mdx @@ -9,5 +9,5 @@ Fallback model to try when the primary model fails or refuses. Only the `model` | Field | Type | Required | Description | Example | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file +| `Model` | `string` | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file diff --git a/docs/models/components/messagesmessageparam.mdx b/docs/models/components/messagesmessageparam.mdx index 174dbf1ac..31877ac94 100644 --- a/docs/models/components/messagesmessageparam.mdx +++ b/docs/models/components/messagesmessageparam.mdx @@ -9,7 +9,7 @@ Anthropic message with OpenRouter extensions | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| `ClearAt` | optionalnullable.OptionalNullable[[components.AnthropicSystemClearAt](../../models/components/anthropicsystemclearat.mdx)] | :heavy_minus_sign: | N/A | next_user_message | -| `Content` | [components.MessagesMessageParamContentUnion5](../../models/components/messagesmessageparamcontentunion5.mdx) | :heavy_check_mark: | N/A | | -| `OutputConfig` | optionalnullable.OptionalNullable[[components.AnthropicMessageOutputConfig](../../models/components/anthropicmessageoutputconfig.mdx)] | :heavy_minus_sign: | N/A | \{
"effort": "low"
} | -| `Role` | [components.MessagesMessageParamRole](../../models/components/messagesmessageparamrole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ClearAt` | optionalnullable.OptionalNullable[[components.AnthropicSystemClearAt](../../models/components/anthropicsystemclearat.mdx)] | ➖ | N/A | next_user_message | +| `Content` | [components.MessagesMessageParamContentUnion5](../../models/components/messagesmessageparamcontentunion5.mdx) | ✅ | N/A | | +| `OutputConfig` | optionalnullable.OptionalNullable[[components.AnthropicMessageOutputConfig](../../models/components/anthropicmessageoutputconfig.mdx)] | ➖ | N/A | \{
"effort": "low"
} | +| `Role` | [components.MessagesMessageParamRole](../../models/components/messagesmessageparamrole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagesoutputconfig.mdx b/docs/models/components/messagesoutputconfig.mdx index 5ec8f99fc..a142cf935 100644 --- a/docs/models/components/messagesoutputconfig.mdx +++ b/docs/models/components/messagesoutputconfig.mdx @@ -9,6 +9,6 @@ Configuration for controlling output behavior. Supports the effort parameter and | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigEffort](../../models/components/messagesoutputconfigeffort.mdx)] | :heavy_minus_sign: | How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. | medium | -| `Format` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigFormat](../../models/components/messagesoutputconfigformat.mdx)] | :heavy_minus_sign: | A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). | | -| `TaskBudget` | optionalnullable.OptionalNullable[[components.TaskBudget](../../models/components/taskbudget.mdx)] | :heavy_minus_sign: | Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap. | \{
"total": 400000,
"type": "tokens"
} | \ No newline at end of file +| `Effort` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigEffort](../../models/components/messagesoutputconfigeffort.mdx)] | ➖ | How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. | medium | +| `Format` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigFormat](../../models/components/messagesoutputconfigformat.mdx)] | ➖ | A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). | | +| `TaskBudget` | optionalnullable.OptionalNullable[[components.TaskBudget](../../models/components/taskbudget.mdx)] | ➖ | Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap. | \{
"total": 400000,
"type": "tokens"
} | \ No newline at end of file diff --git a/docs/models/components/messagesoutputconfigformat.mdx b/docs/models/components/messagesoutputconfigformat.mdx index 5454729a6..e0a8ffd67 100644 --- a/docs/models/components/messagesoutputconfigformat.mdx +++ b/docs/models/components/messagesoutputconfigformat.mdx @@ -9,5 +9,5 @@ A schema to specify Claude's output format in responses. See [structured outputs | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Schema` | map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesOutputConfigTypeJSONSchema](../../models/components/messagesoutputconfigtypejsonschema.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Schema` | map[string]`any` | ✅ | N/A | +| `Type` | [components.MessagesOutputConfigTypeJSONSchema](../../models/components/messagesoutputconfigtypejsonschema.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesrequest.mdx b/docs/models/components/messagesrequest.mdx index 8f21c3027..f6254287b 100644 --- a/docs/models/components/messagesrequest.mdx +++ b/docs/models/components/messagesrequest.mdx @@ -9,30 +9,30 @@ Request schema for Anthropic Messages API endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `ContextManagement` | optionalnullable.OptionalNullable[[components.ContextManagement](../../models/components/contextmanagement.mdx)] | :heavy_minus_sign: | N/A | | -| `Fallbacks` | optionalnullable.OptionalNullable[[][components.MessagesFallbackParam](../../models/components/messagesfallbackparam.mdx)] | :heavy_minus_sign: | Fallback models to try if the primary model fails or refuses, in order. Handled by OpenRouter multi-model routing rather than Anthropic server-side fallbacks; cannot be combined with `models`. Each entry accepts only `model`. Maximum of 3 entries. | [
\{
"model": "claude-opus-4-8"
}
] | -| `MaxTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `Messages` | [][components.MessagesMessageParam](../../models/components/messagesmessageparam.mdx) | :heavy_check_mark: | N/A | | -| `Metadata` | [*components.MessagesRequestMetadata](../../models/components/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Models` | []`string` | :heavy_minus_sign: | N/A | | -| `OutputConfig` | [*components.MessagesOutputConfig](../../models/components/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | -| `Plugins` | [][components.MessagesRequestPlugin](../../models/components/messagesrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `Safeguards` | optionalnullable.OptionalNullable[[][components.AnthropicSafeguard](../../models/components/anthropicsafeguard.mdx)] | :heavy_minus_sign: | N/A | | -| `ServiceTier` | `*string` | :heavy_minus_sign: | N/A | | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `Speed` | optionalnullable.OptionalNullable[[components.Speed](../../models/components/speed.mdx)] | :heavy_minus_sign: | N/A | fast | -| `StopSequences` | []`string` | :heavy_minus_sign: | N/A | | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `Stream` | `*bool` | :heavy_minus_sign: | N/A | | -| `System` | [*components.System](../../models/components/system.mdx) | :heavy_minus_sign: | N/A | | -| `Temperature` | `*float64` | :heavy_minus_sign: | N/A | | -| `Thinking` | [*components.Thinking](../../models/components/thinking.mdx) | :heavy_minus_sign: | N/A | | -| `ToolChoice` | [*components.ToolChoice](../../models/components/toolchoice.mdx) | :heavy_minus_sign: | N/A | | -| `Tools` | [][components.MessagesRequestToolUnion](../../models/components/messagesrequesttoolunion.mdx) | :heavy_minus_sign: | N/A | | -| `TopK` | `*int64` | :heavy_minus_sign: | N/A | | -| `TopP` | `*float64` | :heavy_minus_sign: | N/A | | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `ContextManagement` | optionalnullable.OptionalNullable[[components.ContextManagement](../../models/components/contextmanagement.mdx)] | ➖ | N/A | | +| `Fallbacks` | optionalnullable.OptionalNullable[[][components.MessagesFallbackParam](../../models/components/messagesfallbackparam.mdx)] | ➖ | Fallback models to try if the primary model fails or refuses, in order. Handled by OpenRouter multi-model routing rather than Anthropic server-side fallbacks; cannot be combined with `models`. Each entry accepts only `model`. Maximum of 3 entries. | [
\{
"model": "claude-opus-4-8"
}
] | +| `MaxTokens` | `*int64` | ➖ | N/A | | +| `Messages` | [][components.MessagesMessageParam](../../models/components/messagesmessageparam.mdx) | ✅ | N/A | | +| `Metadata` | [*components.MessagesRequestMetadata](../../models/components/messagesrequestmetadata.mdx) | ➖ | N/A | | +| `Model` | `string` | ✅ | N/A | | +| `Models` | []`string` | ➖ | N/A | | +| `OutputConfig` | [*components.MessagesOutputConfig](../../models/components/messagesoutputconfig.mdx) | ➖ | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `Plugins` | [][components.MessagesRequestPlugin](../../models/components/messagesrequestplugin.mdx) | ➖ | Plugins you want to enable for this request, including their settings. | | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `Safeguards` | optionalnullable.OptionalNullable[[][components.AnthropicSafeguard](../../models/components/anthropicsafeguard.mdx)] | ➖ | N/A | | +| `ServiceTier` | `*string` | ➖ | N/A | | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `Speed` | optionalnullable.OptionalNullable[[components.Speed](../../models/components/speed.mdx)] | ➖ | N/A | fast | +| `StopSequences` | []`string` | ➖ | N/A | | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `Stream` | `*bool` | ➖ | N/A | | +| `System` | [*components.System](../../models/components/system.mdx) | ➖ | N/A | | +| `Temperature` | `*float64` | ➖ | N/A | | +| `Thinking` | [*components.Thinking](../../models/components/thinking.mdx) | ➖ | N/A | | +| `ToolChoice` | [*components.ToolChoice](../../models/components/toolchoice.mdx) | ➖ | N/A | | +| `Tools` | [][components.MessagesRequestToolUnion](../../models/components/messagesrequesttoolunion.mdx) | ➖ | N/A | | +| `TopK` | `*int64` | ➖ | N/A | | +| `TopP` | `*float64` | ➖ | N/A | | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | ➖ | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file diff --git a/docs/models/components/messagesrequestmetadata.mdx b/docs/models/components/messagesrequestmetadata.mdx index 0464ea970..5b6105609 100644 --- a/docs/models/components/messagesrequestmetadata.mdx +++ b/docs/models/components/messagesrequestmetadata.mdx @@ -6,4 +6,4 @@ title: "MessagesRequestMetadata" | Field | Type | Required | Description | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `UserID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `UserID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesrequesttool.mdx b/docs/models/components/messagesrequesttool.mdx index 1d0f0d2a6..8d1015aec 100644 --- a/docs/models/components/messagesrequesttool.mdx +++ b/docs/models/components/messagesrequesttool.mdx @@ -6,5 +6,5 @@ title: "MessagesRequestTool" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | `string` | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagessearchmodelsservertool.mdx b/docs/models/components/messagessearchmodelsservertool.mdx index 24e11474a..cdb17b982 100644 --- a/docs/models/components/messagessearchmodelsservertool.mdx +++ b/docs/models/components/messagessearchmodelsservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.MessagesSearchModelsServerToolType](../../models/components/messagessearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.MessagesSearchModelsServerToolType](../../models/components/messagessearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagesshelltoolresultblock.mdx b/docs/models/components/messagesshelltoolresultblock.mdx index 0633cae11..5cb77aec6 100644 --- a/docs/models/components/messagesshelltoolresultblock.mdx +++ b/docs/models/components/messagesshelltoolresultblock.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:shell` call from a prior assistant turn. Accepted on re | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `Content` | map[string]`any` | :heavy_check_mark: | N/A | -| `Files` | [][components.MessagesShellToolResultBlockFile](../../models/components/messagesshelltoolresultblockfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesShellToolResultBlockTypeOpenrouterShellToolResult](../../models/components/messagesshelltoolresultblocktypeopenroutershelltoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `Content` | map[string]`any` | ✅ | N/A | +| `Files` | [][components.MessagesShellToolResultBlockFile](../../models/components/messagesshelltoolresultblockfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `ToolUseID` | `string` | ✅ | N/A | +| `Type` | [components.MessagesShellToolResultBlockTypeOpenrouterShellToolResult](../../models/components/messagesshelltoolresultblocktypeopenroutershelltoolresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesshelltoolresultblockfile.mdx b/docs/models/components/messagesshelltoolresultblockfile.mdx index dd96a96c6..e3e0075c8 100644 --- a/docs/models/components/messagesshelltoolresultblockfile.mdx +++ b/docs/models/components/messagesshelltoolresultblockfile.mdx @@ -6,9 +6,9 @@ title: "MessagesShellToolResultBlockFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesShellToolResultBlockTypeContainerFileCitation](../../models/components/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `string` | ✅ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Type` | [components.MessagesShellToolResultBlockTypeContainerFileCitation](../../models/components/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblock.mdx b/docs/models/components/messagestooladditionblock.mdx index 04bc32b20..e53057445 100644 --- a/docs/models/components/messagestooladditionblock.mdx +++ b/docs/models/components/messagestooladditionblock.mdx @@ -9,6 +9,6 @@ Loads a previously deferred tool (declared in `tools` with `defer_loading: true` | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Tool` | [components.MessagesToolAdditionBlockToolUnion](../../models/components/messagestooladditionblocktoolunion.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeToolAddition](../../models/components/typetooladdition.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Tool` | [components.MessagesToolAdditionBlockToolUnion](../../models/components/messagestooladditionblocktoolunion.mdx) | ✅ | N/A | | +| `Type` | [components.TypeToolAddition](../../models/components/typetooladdition.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx b/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx index 17210dc92..46d3089e4 100644 --- a/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx +++ b/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx @@ -6,6 +6,6 @@ title: "MessagesToolAdditionBlockToolMcpToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `ServerName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../../models/components/messagestooladditionblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Name` | `string` | ✅ | N/A | +| `ServerName` | `string` | ✅ | N/A | +| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../../models/components/messagestooladditionblocktypemcptoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx b/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx index f0b3ee7f5..c1065af26 100644 --- a/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx +++ b/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolAdditionBlockToolMcpToolsetReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `ServerName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../../models/components/messagestooladditionblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ServerName` | `string` | ✅ | N/A | +| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../../models/components/messagestooladditionblocktypemcptoolsetreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktooltoolreference.mdx b/docs/models/components/messagestooladditionblocktooltoolreference.mdx index 2c827a51b..76c0a95c1 100644 --- a/docs/models/components/messagestooladditionblocktooltoolreference.mdx +++ b/docs/models/components/messagestooladditionblocktooltoolreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolAdditionBlockToolToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeToolReference](../../models/components/messagestooladditionblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Name` | `string` | ✅ | N/A | +| `Type` | [components.MessagesToolAdditionBlockTypeToolReference](../../models/components/messagestooladditionblocktypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblock.mdx b/docs/models/components/messagestoolremovalblock.mdx index c1e4f3ffd..a9b4d5145 100644 --- a/docs/models/components/messagestoolremovalblock.mdx +++ b/docs/models/components/messagestoolremovalblock.mdx @@ -9,6 +9,6 @@ Removes a tool from the conversation mid-conversation without invalidating the p | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Tool` | [components.MessagesToolRemovalBlockToolUnion](../../models/components/messagestoolremovalblocktoolunion.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeToolRemoval](../../models/components/typetoolremoval.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Tool` | [components.MessagesToolRemovalBlockToolUnion](../../models/components/messagestoolremovalblocktoolunion.mdx) | ✅ | N/A | | +| `Type` | [components.TypeToolRemoval](../../models/components/typetoolremoval.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx b/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx index 5ec3917a4..bc0fefce0 100644 --- a/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx +++ b/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx @@ -6,6 +6,6 @@ title: "MessagesToolRemovalBlockToolMcpToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `ServerName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../../models/components/messagestoolremovalblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Name` | `string` | ✅ | N/A | +| `ServerName` | `string` | ✅ | N/A | +| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../../models/components/messagestoolremovalblocktypemcptoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx b/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx index f9f587ae1..158442cd7 100644 --- a/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx +++ b/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolRemovalBlockToolMcpToolsetReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `ServerName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../../models/components/messagestoolremovalblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ServerName` | `string` | ✅ | N/A | +| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../../models/components/messagestoolremovalblocktypemcptoolsetreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktooltoolreference.mdx b/docs/models/components/messagestoolremovalblocktooltoolreference.mdx index c14482031..105666952 100644 --- a/docs/models/components/messagestoolremovalblocktooltoolreference.mdx +++ b/docs/models/components/messagestoolremovalblocktooltoolreference.mdx @@ -6,5 +6,5 @@ title: "MessagesToolRemovalBlockToolToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeToolReference](../../models/components/messagestoolremovalblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Name` | `string` | ✅ | N/A | +| `Type` | [components.MessagesToolRemovalBlockTypeToolReference](../../models/components/messagestoolremovalblocktypetoolreference.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/mismatchbehavior.mdx b/docs/models/components/mismatchbehavior.mdx index a887dcca6..231851846 100644 --- a/docs/models/components/mismatchbehavior.mdx +++ b/docs/models/components/mismatchbehavior.mdx @@ -4,7 +4,7 @@ title: "~~MismatchBehavior~~" Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Example Usage diff --git a/docs/models/components/model.mdx b/docs/models/components/model.mdx index f8b1ee5c7..1cfabfa1d 100644 --- a/docs/models/components/model.mdx +++ b/docs/models/components/model.mdx @@ -9,23 +9,23 @@ Information about an AI model available on OpenRouter | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AliasTarget` | [*components.ModelAliasTarget](../../models/components/modelaliastarget.mdx) | :heavy_minus_sign: | Concrete model targeted by this tilde-latest alias, when applicable | \{
"name": "Claude Sonnet 4.5",
"slug": "anthropic/claude-sonnet-4.5"
} | -| `Architecture` | [components.ModelArchitecture](../../models/components/modelarchitecture.mdx) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `Benchmarks` | [*components.ModelBenchmarks](../../models/components/modelbenchmarks.mdx) | :heavy_minus_sign: | Third-party benchmark rankings for this model. Omitted when no benchmark data is available. | \{
"artificial_analysis": \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
},
"design_arena": [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
]
} | -| `CanonicalSlug` | `string` | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `ContextLength` | `*int64` | :heavy_check_mark: | Maximum context length in tokens | 8192 | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `DefaultParameters` | [*components.DefaultParameters](../../models/components/defaultparameters.mdx) | :heavy_check_mark: | Default parameters for this model | \{
"frequency_penalty": 0,
"presence_penalty": 0,
"repetition_penalty": 1,
"temperature": 0.7,
"top_k": 0,
"top_p": 0.9
} | -| `Description` | `*string` | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `ExpirationDate` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | -| `HuggingFaceID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `KnowledgeCutoff` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 | -| `Links` | [components.ModelLinks](../../models/components/modellinks.mdx) | :heavy_check_mark: | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | -| `Name` | `string` | :heavy_check_mark: | Display name of the model | GPT-4 | -| `PerRequestLimits` | [*components.PerRequestLimits](../../models/components/perrequestlimits.mdx) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | -| `Pricing` | [components.PublicPricing](../../models/components/publicpricing.mdx) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | -| `Reasoning` | [*components.ModelReasoning](../../models/components/modelreasoning.mdx) | :heavy_minus_sign: | Reasoning effort configuration. Omitted for non-reasoning models and dynamic router models. | \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
} | -| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | :heavy_check_mark: | List of supported parameters for this model | | -| `SupportedVoices` | []`string` | :heavy_check_mark: | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | -| `TopProvider` | [components.TopProviderInfo](../../models/components/topproviderinfo.mdx) | :heavy_check_mark: | Information about the top provider for this model | \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
} | \ No newline at end of file +| `AliasTarget` | [*components.ModelAliasTarget](../../models/components/modelaliastarget.mdx) | ➖ | Concrete model targeted by this tilde-latest alias, when applicable | \{
"name": "Claude Sonnet 4.5",
"slug": "anthropic/claude-sonnet-4.5"
} | +| `Architecture` | [components.ModelArchitecture](../../models/components/modelarchitecture.mdx) | ✅ | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `Benchmarks` | [*components.ModelBenchmarks](../../models/components/modelbenchmarks.mdx) | ➖ | Third-party benchmark rankings for this model. Omitted when no benchmark data is available. | \{
"artificial_analysis": \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
},
"design_arena": [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
]
} | +| `CanonicalSlug` | `string` | ✅ | Canonical slug for the model | openai/gpt-4 | +| `ContextLength` | `*int64` | ✅ | Maximum context length in tokens | 8192 | +| `Created` | `int64` | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `DefaultParameters` | [*components.DefaultParameters](../../models/components/defaultparameters.mdx) | ✅ | Default parameters for this model | \{
"frequency_penalty": 0,
"presence_penalty": 0,
"repetition_penalty": 1,
"temperature": 0.7,
"top_k": 0,
"top_p": 0.9
} | +| `Description` | `*string` | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `ExpirationDate` | optionalnullable.OptionalNullable[`string`] | ➖ | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | +| `HuggingFaceID` | optionalnullable.OptionalNullable[`string`] | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `ID` | `string` | ✅ | Unique identifier for the model | openai/gpt-4 | +| `KnowledgeCutoff` | optionalnullable.OptionalNullable[`string`] | ➖ | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 | +| `Links` | [components.ModelLinks](../../models/components/modellinks.mdx) | ✅ | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | +| `Name` | `string` | ✅ | Display name of the model | GPT-4 | +| `PerRequestLimits` | [*components.PerRequestLimits](../../models/components/perrequestlimits.mdx) | ✅ | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | +| `Pricing` | [components.PublicPricing](../../models/components/publicpricing.mdx) | ✅ | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | +| `Reasoning` | [*components.ModelReasoning](../../models/components/modelreasoning.mdx) | ➖ | Reasoning effort configuration. Omitted for non-reasoning models and dynamic router models. | \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
} | +| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | ✅ | List of supported parameters for this model | | +| `SupportedVoices` | []`string` | ✅ | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | +| `TopProvider` | [components.TopProviderInfo](../../models/components/topproviderinfo.mdx) | ✅ | Information about the top provider for this model | \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
} | \ No newline at end of file diff --git a/docs/models/components/modelaliastarget.mdx b/docs/models/components/modelaliastarget.mdx index 3a99ae71f..e53c88828 100644 --- a/docs/models/components/modelaliastarget.mdx +++ b/docs/models/components/modelaliastarget.mdx @@ -9,5 +9,5 @@ Concrete model targeted by this tilde-latest alias, when applicable | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Name` | `string` | :heavy_check_mark: | Human-readable name of the concrete model targeted by this alias | -| `Slug` | `string` | :heavy_check_mark: | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file +| `Name` | `string` | ✅ | Human-readable name of the concrete model targeted by this alias | +| `Slug` | `string` | ✅ | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file diff --git a/docs/models/components/modelarchitecture.mdx b/docs/models/components/modelarchitecture.mdx index 0a41c1fcd..235cbf81e 100644 --- a/docs/models/components/modelarchitecture.mdx +++ b/docs/models/components/modelarchitecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | :heavy_check_mark: | Supported input modalities | | -| `InstructType` | optionalnullable.OptionalNullable[[components.InstructType](../../models/components/instructtype.mdx)] | :heavy_minus_sign: | Instruction format type | chatml | -| `Modality` | `*string` | :heavy_check_mark: | Primary modality of the model | text->text | -| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | :heavy_check_mark: | Supported output modalities | | -| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file +| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | ✅ | Supported input modalities | | +| `InstructType` | optionalnullable.OptionalNullable[[components.InstructType](../../models/components/instructtype.mdx)] | ➖ | Instruction format type | chatml | +| `Modality` | `*string` | ✅ | Primary modality of the model | text->text | +| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | ✅ | Supported output modalities | | +| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | ➖ | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/docs/models/components/modelbenchmarks.mdx b/docs/models/components/modelbenchmarks.mdx index d5cae8857..f35bfc48c 100644 --- a/docs/models/components/modelbenchmarks.mdx +++ b/docs/models/components/modelbenchmarks.mdx @@ -9,5 +9,5 @@ Third-party benchmark rankings for this model. Omitted when no benchmark data is | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ArtificialAnalysis` | [*components.AABenchmarkEntry](../../models/components/aabenchmarkentry.mdx) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | -| `DesignArena` | [][components.DABenchmarkEntry](../../models/components/dabenchmarkentry.mdx) | :heavy_check_mark: | Design Arena ELO rankings across arena+category pairs. | [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
] | \ No newline at end of file +| `ArtificialAnalysis` | [*components.AABenchmarkEntry](../../models/components/aabenchmarkentry.mdx) | ➖ | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | +| `DesignArena` | [][components.DABenchmarkEntry](../../models/components/dabenchmarkentry.mdx) | ✅ | Design Arena ELO rankings across arena+category pairs. | [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
] | \ No newline at end of file diff --git a/docs/models/components/modellinks.mdx b/docs/models/components/modellinks.mdx index 1273737d5..5c725e7b8 100644 --- a/docs/models/components/modellinks.mdx +++ b/docs/models/components/modellinks.mdx @@ -9,4 +9,4 @@ Related API endpoints and resources for this model. | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `Details` | `string` | :heavy_check_mark: | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file +| `Details` | `string` | ✅ | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file diff --git a/docs/models/components/modelreasoning.mdx b/docs/models/components/modelreasoning.mdx index 4888367ce..a5b000f6d 100644 --- a/docs/models/components/modelreasoning.mdx +++ b/docs/models/components/modelreasoning.mdx @@ -9,8 +9,8 @@ Reasoning effort configuration. Omitted for non-reasoning models and dynamic rou | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `DefaultEffort` | optionalnullable.OptionalNullable[[components.DefaultEffort](../../models/components/defaulteffort.mdx)] | :heavy_minus_sign: | N/A | medium | -| `DefaultEnabled` | `*bool` | :heavy_minus_sign: | Default reasoning enabled state when the client does not set `reasoning.enabled`. | | -| `Mandatory` | `bool` | :heavy_check_mark: | When true, reasoning cannot be disabled and effort "none" is rejected. | | -| `SupportedEfforts` | optionalnullable.OptionalNullable[[][*components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | :heavy_minus_sign: | Allowed reasoning effort values for this model, in descending effort order (highest first). Null means no allowlist — all gateway effort values are accepted. | | -| `SupportsMaxTokens` | `*bool` | :heavy_minus_sign: | Present and `true` when the model accepts `reasoning.max_tokens` in requests (Anthropic-style) instead of or in addition to `reasoning.effort`. Omitted otherwise. | | \ No newline at end of file +| `DefaultEffort` | optionalnullable.OptionalNullable[[components.DefaultEffort](../../models/components/defaulteffort.mdx)] | ➖ | N/A | medium | +| `DefaultEnabled` | `*bool` | ➖ | Default reasoning enabled state when the client does not set `reasoning.enabled`. | | +| `Mandatory` | `bool` | ✅ | When true, reasoning cannot be disabled and effort "none" is rejected. | | +| `SupportedEfforts` | optionalnullable.OptionalNullable[[][*components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | ➖ | Allowed reasoning effort values for this model, in descending effort order (highest first). Null means no allowlist — all gateway effort values are accepted. | | +| `SupportsMaxTokens` | `*bool` | ➖ | Present and `true` when the model accepts `reasoning.max_tokens` in requests (Anthropic-style) instead of or in addition to `reasoning.effort`. Omitted otherwise. | | \ No newline at end of file diff --git a/docs/models/components/modelresponse.mdx b/docs/models/components/modelresponse.mdx index ac70fdd90..91e2a4b91 100644 --- a/docs/models/components/modelresponse.mdx +++ b/docs/models/components/modelresponse.mdx @@ -9,4 +9,4 @@ Single model response | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Model](../../models/components/model.mdx) | :heavy_check_mark: | Information about an AI model available on OpenRouter | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"reasoning": \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
} | \ No newline at end of file +| `Data` | [components.Model](../../models/components/model.mdx) | ✅ | Information about an AI model available on OpenRouter | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"reasoning": \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
} | \ No newline at end of file diff --git a/docs/models/components/modelscountresponse.mdx b/docs/models/components/modelscountresponse.mdx index 04b817d9e..4044230c8 100644 --- a/docs/models/components/modelscountresponse.mdx +++ b/docs/models/components/modelscountresponse.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Data` | [components.ModelsCountResponseData](../../models/components/modelscountresponsedata.mdx) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file +| `Data` | [components.ModelsCountResponseData](../../models/components/modelscountresponsedata.mdx) | ✅ | Model count data | \{
"count": 150
} | \ No newline at end of file diff --git a/docs/models/components/modelscountresponsedata.mdx b/docs/models/components/modelscountresponsedata.mdx index 42e60f32c..2ffd7a93e 100644 --- a/docs/models/components/modelscountresponsedata.mdx +++ b/docs/models/components/modelscountresponsedata.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `Count` | `int64` | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file +| `Count` | `int64` | ✅ | Total number of available models | 150 | \ No newline at end of file diff --git a/docs/models/components/modelslistresponse.mdx b/docs/models/components/modelslistresponse.mdx index ef5d7e350..10a74b63b 100644 --- a/docs/models/components/modelslistresponse.mdx +++ b/docs/models/components/modelslistresponse.mdx @@ -9,6 +9,6 @@ List of available models | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.Model](../../models/components/model.mdx) | :heavy_check_mark: | List of available models | [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
] | -| `Links` | [components.ModelsListResponseLinks](../../models/components/modelslistresponselinks.mdx) | :heavy_check_mark: | Pagination links | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of models matching the query | 150 | \ No newline at end of file +| `Data` | [][components.Model](../../models/components/model.mdx) | ✅ | List of available models | [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
] | +| `Links` | [components.ModelsListResponseLinks](../../models/components/modelslistresponselinks.mdx) | ✅ | Pagination links | | +| `TotalCount` | `int64` | ✅ | Total number of models matching the query | 150 | \ No newline at end of file diff --git a/docs/models/components/modelslistresponselinks.mdx b/docs/models/components/modelslistresponselinks.mdx index 3e5dbd139..c366d0d34 100644 --- a/docs/models/components/modelslistresponselinks.mdx +++ b/docs/models/components/modelslistresponselinks.mdx @@ -9,4 +9,4 @@ Pagination links | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Next` | `*string` | :heavy_check_mark: | URL for the next page of results, or null if this is the last page | /api/v1/models?offset=500&limit=500 | \ No newline at end of file +| `Next` | `*string` | ✅ | URL for the next page of results, or null if this is the last page | /api/v1/models?offset=500&limit=500 | \ No newline at end of file diff --git a/docs/models/components/moderationplugin.mdx b/docs/models/components/moderationplugin.mdx index 589e0cdd2..48856fd8f 100644 --- a/docs/models/components/moderationplugin.mdx +++ b/docs/models/components/moderationplugin.mdx @@ -6,4 +6,4 @@ title: "ModerationPlugin" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ID` | [components.ModerationPluginID](../../models/components/moderationpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ID` | [components.ModerationPluginID](../../models/components/moderationpluginid.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/multimodalmedia.mdx b/docs/models/components/multimodalmedia.mdx index d1b0a4973..dfc47ecb9 100644 --- a/docs/models/components/multimodalmedia.mdx +++ b/docs/models/components/multimodalmedia.mdx @@ -6,5 +6,5 @@ title: "MultimodalMedia" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `Format` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Data` | `string` | ✅ | N/A | +| `Format` | `*string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/namespacefunctiontool.mdx b/docs/models/components/namespacefunctiontool.mdx index 4c46f05a4..230ec6ce3 100644 --- a/docs/models/components/namespacefunctiontool.mdx +++ b/docs/models/components/namespacefunctiontool.mdx @@ -9,12 +9,12 @@ A function tool grouped inside a namespace tool | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedCallers` | optionalnullable.OptionalNullable[[][components.AllowedCaller](../../models/components/allowedcaller.mdx)] | :heavy_minus_sign: | N/A | | -| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `OutputSchema` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | | -| `Parameters` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.NamespaceFunctionToolType](../../models/components/namespacefunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `AllowedCallers` | optionalnullable.OptionalNullable[[][components.AllowedCaller](../../models/components/allowedcaller.mdx)] | ➖ | N/A | | +| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | ➖ | N/A | | +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `OutputSchema` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | | +| `Parameters` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `Type` | [components.NamespaceFunctionToolType](../../models/components/namespacefunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/namespacetool.mdx b/docs/models/components/namespacetool.mdx index 63b20c09b..a371cb56d 100644 --- a/docs/models/components/namespacetool.mdx +++ b/docs/models/components/namespacetool.mdx @@ -9,7 +9,7 @@ Groups function/custom tools under a shared namespace | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Description` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Tools` | [][components.NamespaceToolTool](../../models/components/namespacetooltool.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.NamespaceToolType](../../models/components/namespacetooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Description` | `string` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | +| `Tools` | [][components.NamespaceToolTool](../../models/components/namespacetooltool.mdx) | ✅ | N/A | +| `Type` | [components.NamespaceToolType](../../models/components/namespacetooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/nativesupport.mdx b/docs/models/components/nativesupport.mdx index 712f26a7b..d69276ca6 100644 --- a/docs/models/components/nativesupport.mdx +++ b/docs/models/components/nativesupport.mdx @@ -9,6 +9,6 @@ Endpoints whose provider runs this tool itself during inference. Zero for tools | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `EndpointCount` | `int64` | :heavy_check_mark: | N/A | 18 | -| `ModelCount` | `int64` | :heavy_check_mark: | N/A | 12 | -| `Models` | [][components.ServerToolNativeModel](../../models/components/servertoolnativemodel.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `EndpointCount` | `int64` | ✅ | N/A | 18 | +| `ModelCount` | `int64` | ✅ | N/A | 12 | +| `Models` | [][components.ServerToolNativeModel](../../models/components/servertoolnativemodel.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/nativetools.mdx b/docs/models/components/nativetools.mdx index 2e0483ed4..bfdf5a3a0 100644 --- a/docs/models/components/nativetools.mdx +++ b/docs/models/components/nativetools.mdx @@ -6,4 +6,4 @@ title: "NativeTools" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Type` | `string` | :heavy_check_mark: | The provider tool type the request is translated to when this tool runs natively, e.g. `web_search_20260209` on Anthropic or `google_search` on Gemini. | \ No newline at end of file +| `Type` | `string` | ✅ | The provider tool type the request is translated to when this tool runs natively, e.g. `web_search_20260209` on Anthropic or `google_search` on Gemini. | \ No newline at end of file diff --git a/docs/models/components/never.mdx b/docs/models/components/never.mdx index 0d6a9b031..6d40ecc31 100644 --- a/docs/models/components/never.mdx +++ b/docs/models/components/never.mdx @@ -6,4 +6,4 @@ title: "Never" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ToolNames` | []`string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/notfoundresponseerrordata.mdx b/docs/models/components/notfoundresponseerrordata.mdx index f1786ff95..6343f9182 100644 --- a/docs/models/components/notfoundresponseerrordata.mdx +++ b/docs/models/components/notfoundresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for NotFoundResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/oauthjwks.mdx b/docs/models/components/oauthjwks.mdx index 6f694de91..3314dbc90 100644 --- a/docs/models/components/oauthjwks.mdx +++ b/docs/models/components/oauthjwks.mdx @@ -9,4 +9,4 @@ RFC 7517 JWK Set of the keys OpenRouter signs access tokens with. | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Keys` | [][components.Key](../../models/components/key.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Keys` | [][components.Key](../../models/components/key.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityarizedestination.mdx b/docs/models/components/observabilityarizedestination.mdx index 2b3ec3a69..8bfd85ed3 100644 --- a/docs/models/components/observabilityarizedestination.mdx +++ b/docs/models/components/observabilityarizedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityArizeDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityArizeDestinationConfig](../../models/components/observabilityarizedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityArizeDestinationType](../../models/components/observabilityarizedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityArizeDestinationConfig](../../models/components/observabilityarizedestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityArizeDestinationType](../../models/components/observabilityarizedestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityarizedestinationconfig.mdx b/docs/models/components/observabilityarizedestinationconfig.mdx index 63f7eb5fa..27a844955 100644 --- a/docs/models/components/observabilityarizedestinationconfig.mdx +++ b/docs/models/components/observabilityarizedestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityArizeDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `ModelID` | `string` | :heavy_check_mark: | The name of the tracing project in Arize AX | -| `SpaceKey` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `APIKey` | `string` | ✅ | N/A | +| `BaseURL` | `*string` | ➖ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `ModelID` | `string` | ✅ | The name of the tracing project in Arize AX | +| `SpaceKey` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitybraintrustdestination.mdx b/docs/models/components/observabilitybraintrustdestination.mdx index 6ad5d1c7a..9a8d41c22 100644 --- a/docs/models/components/observabilitybraintrustdestination.mdx +++ b/docs/models/components/observabilitybraintrustdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityBraintrustDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityBraintrustDestinationConfig](../../models/components/observabilitybraintrustdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityBraintrustDestinationType](../../models/components/observabilitybraintrustdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityBraintrustDestinationConfig](../../models/components/observabilitybraintrustdestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityBraintrustDestinationType](../../models/components/observabilitybraintrustdestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitybraintrustdestinationconfig.mdx b/docs/models/components/observabilitybraintrustdestinationconfig.mdx index 77e375f62..827b1afc5 100644 --- a/docs/models/components/observabilitybraintrustdestinationconfig.mdx +++ b/docs/models/components/observabilitybraintrustdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityBraintrustDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `ProjectID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `APIKey` | `string` | ✅ | N/A | +| `BaseURL` | `*string` | ➖ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `ProjectID` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityclickhousedestination.mdx b/docs/models/components/observabilityclickhousedestination.mdx index b9d41f5db..d1e8a1790 100644 --- a/docs/models/components/observabilityclickhousedestination.mdx +++ b/docs/models/components/observabilityclickhousedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityClickhouseDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityClickhouseDestinationConfig](../../models/components/observabilityclickhousedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityClickhouseDestinationType](../../models/components/observabilityclickhousedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityClickhouseDestinationConfig](../../models/components/observabilityclickhousedestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityClickhouseDestinationType](../../models/components/observabilityclickhousedestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityclickhousedestinationconfig.mdx b/docs/models/components/observabilityclickhousedestinationconfig.mdx index db41a707c..c1410ec1f 100644 --- a/docs/models/components/observabilityclickhousedestinationconfig.mdx +++ b/docs/models/components/observabilityclickhousedestinationconfig.mdx @@ -6,10 +6,10 @@ title: "ObservabilityClickhouseDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Database` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `Host` | `string` | :heavy_check_mark: | N/A | -| `Password` | `string` | :heavy_check_mark: | N/A | -| `ShouldIncludeCacheWriteTokens` | `*bool` | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `Table` | `*string` | :heavy_minus_sign: | N/A | -| `Username` | `string` | :heavy_check_mark: | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file +| `Database` | `string` | ✅ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `Host` | `string` | ✅ | N/A | +| `Password` | `string` | ✅ | N/A | +| `ShouldIncludeCacheWriteTokens` | `*bool` | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `Table` | `*string` | ➖ | N/A | +| `Username` | `string` | ✅ | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file diff --git a/docs/models/components/observabilitydatadogdestination.mdx b/docs/models/components/observabilitydatadogdestination.mdx index 504ff43ca..ce82ebe1d 100644 --- a/docs/models/components/observabilitydatadogdestination.mdx +++ b/docs/models/components/observabilitydatadogdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityDatadogDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityDatadogDestinationConfig](../../models/components/observabilitydatadogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityDatadogDestinationType](../../models/components/observabilitydatadogdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityDatadogDestinationConfig](../../models/components/observabilitydatadogdestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityDatadogDestinationType](../../models/components/observabilitydatadogdestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitydatadogdestinationconfig.mdx b/docs/models/components/observabilitydatadogdestinationconfig.mdx index 87aed2460..1108f66ac 100644 --- a/docs/models/components/observabilitydatadogdestinationconfig.mdx +++ b/docs/models/components/observabilitydatadogdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityDatadogDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | Datadog API key must have LLM Observability permissions. Create at: | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `MlApp` | `string` | :heavy_check_mark: | Name to identify your application in Datadog LLM Observability | -| `URL` | `*string` | :heavy_minus_sign: | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.us5.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file +| `APIKey` | `string` | ✅ | Datadog API key must have LLM Observability permissions. Create at: | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `MlApp` | `string` | ✅ | Name to identify your application in Datadog LLM Observability | +| `URL` | `*string` | ➖ | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.us5.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file diff --git a/docs/models/components/observabilityfilterrulegroup.mdx b/docs/models/components/observabilityfilterrulegroup.mdx index a9a091697..5e380e8bf 100644 --- a/docs/models/components/observabilityfilterrulegroup.mdx +++ b/docs/models/components/observabilityfilterrulegroup.mdx @@ -6,5 +6,5 @@ title: "ObservabilityFilterRuleGroup" | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Logic` | [*components.Logic](../../models/components/logic.mdx) | :heavy_minus_sign: | N/A | -| `Rules` | [][components.Rule](../../models/components/rule.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Logic` | [*components.Logic](../../models/components/logic.mdx) | ➖ | N/A | +| `Rules` | [][components.Rule](../../models/components/rule.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityfilterrulesconfig.mdx b/docs/models/components/observabilityfilterrulesconfig.mdx index a7593a36d..d3dc2764e 100644 --- a/docs/models/components/observabilityfilterrulesconfig.mdx +++ b/docs/models/components/observabilityfilterrulesconfig.mdx @@ -9,5 +9,5 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | -| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | N/A | +| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityfilterrulesconfignullable.mdx b/docs/models/components/observabilityfilterrulesconfignullable.mdx index adfe79152..7f1981f42 100644 --- a/docs/models/components/observabilityfilterrulesconfignullable.mdx +++ b/docs/models/components/observabilityfilterrulesconfignullable.mdx @@ -9,5 +9,5 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | -| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | N/A | +| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitygrafanadestination.mdx b/docs/models/components/observabilitygrafanadestination.mdx index ba083b738..a6c71072f 100644 --- a/docs/models/components/observabilitygrafanadestination.mdx +++ b/docs/models/components/observabilitygrafanadestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityGrafanaDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityGrafanaDestinationConfig](../../models/components/observabilitygrafanadestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityGrafanaDestinationType](../../models/components/observabilitygrafanadestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityGrafanaDestinationConfig](../../models/components/observabilitygrafanadestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityGrafanaDestinationType](../../models/components/observabilitygrafanadestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitygrafanadestinationconfig.mdx b/docs/models/components/observabilitygrafanadestinationconfig.mdx index 43051e2bc..399b1c5be 100644 --- a/docs/models/components/observabilitygrafanadestinationconfig.mdx +++ b/docs/models/components/observabilitygrafanadestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityGrafanaDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `InstanceID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `APIKey` | `string` | ✅ | N/A | +| `BaseURL` | `*string` | ➖ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `InstanceID` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitylangfusedestination.mdx b/docs/models/components/observabilitylangfusedestination.mdx index eb59e746c..200b837f7 100644 --- a/docs/models/components/observabilitylangfusedestination.mdx +++ b/docs/models/components/observabilitylangfusedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityLangfuseDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityLangfuseDestinationConfig](../../models/components/observabilitylangfusedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityLangfuseDestinationType](../../models/components/observabilitylangfusedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityLangfuseDestinationConfig](../../models/components/observabilitylangfusedestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityLangfuseDestinationType](../../models/components/observabilitylangfusedestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitylangfusedestinationconfig.mdx b/docs/models/components/observabilitylangfusedestinationconfig.mdx index f21f733b0..a97e36e4a 100644 --- a/docs/models/components/observabilitylangfusedestinationconfig.mdx +++ b/docs/models/components/observabilitylangfusedestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityLangfuseDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `PublicKey` | `string` | :heavy_check_mark: | N/A | -| `SecretKey` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `BaseURL` | `*string` | ➖ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `PublicKey` | `string` | ✅ | N/A | +| `SecretKey` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitylangsmithdestination.mdx b/docs/models/components/observabilitylangsmithdestination.mdx index 3df267966..6fca56362 100644 --- a/docs/models/components/observabilitylangsmithdestination.mdx +++ b/docs/models/components/observabilitylangsmithdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityLangsmithDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityLangsmithDestinationConfig](../../models/components/observabilitylangsmithdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityLangsmithDestinationType](../../models/components/observabilitylangsmithdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityLangsmithDestinationConfig](../../models/components/observabilitylangsmithdestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityLangsmithDestinationType](../../models/components/observabilitylangsmithdestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitylangsmithdestinationconfig.mdx b/docs/models/components/observabilitylangsmithdestinationconfig.mdx index 08ecaf8e3..505b9c51f 100644 --- a/docs/models/components/observabilitylangsmithdestinationconfig.mdx +++ b/docs/models/components/observabilitylangsmithdestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityLangsmithDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `Endpoint` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `Project` | `*string` | :heavy_minus_sign: | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file +| `APIKey` | `string` | ✅ | N/A | +| `Endpoint` | `*string` | ➖ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `Project` | `*string` | ➖ | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | +| `WorkspaceID` | `*string` | ➖ | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file diff --git a/docs/models/components/observabilitynewrelicdestination.mdx b/docs/models/components/observabilitynewrelicdestination.mdx index 86b101555..1b8b48c03 100644 --- a/docs/models/components/observabilitynewrelicdestination.mdx +++ b/docs/models/components/observabilitynewrelicdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityNewrelicDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityNewrelicDestinationConfig](../../models/components/observabilitynewrelicdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityNewrelicDestinationType](../../models/components/observabilitynewrelicdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityNewrelicDestinationConfig](../../models/components/observabilitynewrelicdestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityNewrelicDestinationType](../../models/components/observabilitynewrelicdestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitynewrelicdestinationconfig.mdx b/docs/models/components/observabilitynewrelicdestinationconfig.mdx index 380655d73..3f0c41cfc 100644 --- a/docs/models/components/observabilitynewrelicdestinationconfig.mdx +++ b/docs/models/components/observabilitynewrelicdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityNewrelicDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `LicenseKey` | `string` | :heavy_check_mark: | N/A | -| `Region` | [*components.Region](../../models/components/region.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `LicenseKey` | `string` | ✅ | N/A | +| `Region` | [*components.Region](../../models/components/region.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityopikdestination.mdx b/docs/models/components/observabilityopikdestination.mdx index 53039a8cf..f0fd77f18 100644 --- a/docs/models/components/observabilityopikdestination.mdx +++ b/docs/models/components/observabilityopikdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityOpikDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityOpikDestinationConfig](../../models/components/observabilityopikdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityOpikDestinationType](../../models/components/observabilityopikdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityOpikDestinationConfig](../../models/components/observabilityopikdestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityOpikDestinationType](../../models/components/observabilityopikdestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityopikdestinationconfig.mdx b/docs/models/components/observabilityopikdestinationconfig.mdx index 258428c36..c5c3c4777 100644 --- a/docs/models/components/observabilityopikdestinationconfig.mdx +++ b/docs/models/components/observabilityopikdestinationconfig.mdx @@ -6,7 +6,7 @@ title: "ObservabilityOpikDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `ProjectName` | `string` | :heavy_check_mark: | N/A | -| `Workspace` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `APIKey` | `string` | ✅ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `ProjectName` | `string` | ✅ | N/A | +| `Workspace` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityotelcollectordestination.mdx b/docs/models/components/observabilityotelcollectordestination.mdx index be974c081..be970ae05 100644 --- a/docs/models/components/observabilityotelcollectordestination.mdx +++ b/docs/models/components/observabilityotelcollectordestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityOtelCollectorDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityOtelCollectorDestinationConfig](../../models/components/observabilityotelcollectordestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityOtelCollectorDestinationType](../../models/components/observabilityotelcollectordestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityOtelCollectorDestinationConfig](../../models/components/observabilityotelcollectordestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityOtelCollectorDestinationType](../../models/components/observabilityotelcollectordestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityotelcollectordestinationconfig.mdx b/docs/models/components/observabilityotelcollectordestinationconfig.mdx index 569730f46..b8e5b18a2 100644 --- a/docs/models/components/observabilityotelcollectordestinationconfig.mdx +++ b/docs/models/components/observabilityotelcollectordestinationconfig.mdx @@ -6,5 +6,5 @@ title: "ObservabilityOtelCollectorDestinationConfig" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Endpoint` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers as a JSON object. For Axiom, use \{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"} | \ No newline at end of file +| `Endpoint` | `string` | ✅ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers as a JSON object. For Axiom, use \{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"} | \ No newline at end of file diff --git a/docs/models/components/observabilityposthogdestination.mdx b/docs/models/components/observabilityposthogdestination.mdx index 08226b8a5..9a78fec54 100644 --- a/docs/models/components/observabilityposthogdestination.mdx +++ b/docs/models/components/observabilityposthogdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityPosthogDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityPosthogDestinationConfig](../../models/components/observabilityposthogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityPosthogDestinationType](../../models/components/observabilityposthogdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityPosthogDestinationConfig](../../models/components/observabilityposthogdestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityPosthogDestinationType](../../models/components/observabilityposthogdestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityposthogdestinationconfig.mdx b/docs/models/components/observabilityposthogdestinationconfig.mdx index 15721e28e..7192c799b 100644 --- a/docs/models/components/observabilityposthogdestinationconfig.mdx +++ b/docs/models/components/observabilityposthogdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityPosthogDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `Endpoint` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file +| `APIKey` | `string` | ✅ | N/A | +| `Endpoint` | `*string` | ➖ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file diff --git a/docs/models/components/observabilityrampdestination.mdx b/docs/models/components/observabilityrampdestination.mdx index 0332528ca..fe80965c6 100644 --- a/docs/models/components/observabilityrampdestination.mdx +++ b/docs/models/components/observabilityrampdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityRampDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityRampDestinationConfig](../../models/components/observabilityrampdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityRampDestinationType](../../models/components/observabilityrampdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityRampDestinationConfig](../../models/components/observabilityrampdestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityRampDestinationType](../../models/components/observabilityrampdestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityrampdestinationconfig.mdx b/docs/models/components/observabilityrampdestinationconfig.mdx index 46d1c2e0f..bcc343e33 100644 --- a/docs/models/components/observabilityrampdestinationconfig.mdx +++ b/docs/models/components/observabilityrampdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityRampDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | Generate this in your Ramp integration settings. | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file +| `APIKey` | `string` | ✅ | Generate this in your Ramp integration settings. | +| `BaseURL` | `*string` | ➖ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file diff --git a/docs/models/components/observabilitys3destination.mdx b/docs/models/components/observabilitys3destination.mdx index 42c2c817b..0021eb888 100644 --- a/docs/models/components/observabilitys3destination.mdx +++ b/docs/models/components/observabilitys3destination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityS3Destination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityS3DestinationConfig](../../models/components/observabilitys3destinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityS3DestinationType](../../models/components/observabilitys3destinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityS3DestinationConfig](../../models/components/observabilitys3destinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityS3DestinationType](../../models/components/observabilitys3destinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitys3destinationconfig.mdx b/docs/models/components/observabilitys3destinationconfig.mdx index fb2e4f95c..c9c8d1d26 100644 --- a/docs/models/components/observabilitys3destinationconfig.mdx +++ b/docs/models/components/observabilitys3destinationconfig.mdx @@ -6,12 +6,12 @@ title: "ObservabilityS3DestinationConfig" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AccessKeyID` | `string` | :heavy_check_mark: | N/A | -| `BucketName` | `string` | :heavy_check_mark: | N/A | -| `Endpoint` | `*string` | :heavy_minus_sign: | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `PathTemplate` | `*string` | :heavy_minus_sign: | Template for S3 object path. The filename (\{traceId}-\{timestamp}.json) is automatically appended. Available variables: \{prefix}, \{date}, \{year}, \{month}, \{day}, \{apiKeyName} | -| `Prefix` | `*string` | :heavy_minus_sign: | N/A | -| `Region` | `*string` | :heavy_minus_sign: | N/A | -| `SecretAccessKey` | `string` | :heavy_check_mark: | N/A | -| `SessionToken` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `AccessKeyID` | `string` | ✅ | N/A | +| `BucketName` | `string` | ✅ | N/A | +| `Endpoint` | `*string` | ➖ | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `PathTemplate` | `*string` | ➖ | Template for S3 object path. The filename (\{traceId}-\{timestamp}.json) is automatically appended. Available variables: \{prefix}, \{date}, \{year}, \{month}, \{day}, \{apiKeyName} | +| `Prefix` | `*string` | ➖ | N/A | +| `Region` | `*string` | ➖ | N/A | +| `SecretAccessKey` | `string` | ✅ | N/A | +| `SessionToken` | `*string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitysentrydestination.mdx b/docs/models/components/observabilitysentrydestination.mdx index 84f50039c..5227c9a8c 100644 --- a/docs/models/components/observabilitysentrydestination.mdx +++ b/docs/models/components/observabilitysentrydestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilitySentryDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilitySentryDestinationConfig](../../models/components/observabilitysentrydestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilitySentryDestinationType](../../models/components/observabilitysentrydestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilitySentryDestinationConfig](../../models/components/observabilitysentrydestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilitySentryDestinationType](../../models/components/observabilitysentrydestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitysentrydestinationconfig.mdx b/docs/models/components/observabilitysentrydestinationconfig.mdx index 110212416..24af6ebc4 100644 --- a/docs/models/components/observabilitysentrydestinationconfig.mdx +++ b/docs/models/components/observabilitysentrydestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilitySentryDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Dsn` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `OtlpEndpoint` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Dsn` | `string` | ✅ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `OtlpEndpoint` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitysnowflakedestination.mdx b/docs/models/components/observabilitysnowflakedestination.mdx index 91813d604..7b4cae505 100644 --- a/docs/models/components/observabilitysnowflakedestination.mdx +++ b/docs/models/components/observabilitysnowflakedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilitySnowflakeDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilitySnowflakeDestinationConfig](../../models/components/observabilitysnowflakedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilitySnowflakeDestinationType](../../models/components/observabilitysnowflakedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilitySnowflakeDestinationConfig](../../models/components/observabilitysnowflakedestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilitySnowflakeDestinationType](../../models/components/observabilitysnowflakedestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitysnowflakedestinationconfig.mdx b/docs/models/components/observabilitysnowflakedestinationconfig.mdx index 09e5f8532..3eadc916e 100644 --- a/docs/models/components/observabilitysnowflakedestinationconfig.mdx +++ b/docs/models/components/observabilitysnowflakedestinationconfig.mdx @@ -6,11 +6,11 @@ title: "ObservabilitySnowflakeDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Account` | `string` | :heavy_check_mark: | N/A | -| `Database` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `Schema` | `*string` | :heavy_minus_sign: | N/A | -| `ShouldIncludeCacheWriteTokens` | `*bool` | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `Table` | `*string` | :heavy_minus_sign: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | -| `Warehouse` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Account` | `string` | ✅ | N/A | +| `Database` | `*string` | ➖ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `Schema` | `*string` | ➖ | N/A | +| `ShouldIncludeCacheWriteTokens` | `*bool` | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `Table` | `*string` | ➖ | N/A | +| `Token` | `string` | ✅ | N/A | +| `Warehouse` | `*string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityweavedestination.mdx b/docs/models/components/observabilityweavedestination.mdx index e86d8edcf..68991bd31 100644 --- a/docs/models/components/observabilityweavedestination.mdx +++ b/docs/models/components/observabilityweavedestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityWeaveDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityWeaveDestinationConfig](../../models/components/observabilityweavedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityWeaveDestinationType](../../models/components/observabilityweavedestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityWeaveDestinationConfig](../../models/components/observabilityweavedestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityWeaveDestinationType](../../models/components/observabilityweavedestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilityweavedestinationconfig.mdx b/docs/models/components/observabilityweavedestinationconfig.mdx index f49d7555e..22ccdc391 100644 --- a/docs/models/components/observabilityweavedestinationconfig.mdx +++ b/docs/models/components/observabilityweavedestinationconfig.mdx @@ -6,8 +6,8 @@ title: "ObservabilityWeaveDestinationConfig" | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Entity` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `Project` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `APIKey` | `string` | ✅ | N/A | +| `BaseURL` | `*string` | ➖ | N/A | +| `Entity` | `string` | ✅ | N/A | +| `Headers` | map[string]`string` | ➖ | Custom HTTP headers to include in requests to this destination. | +| `Project` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitywebhookdestination.mdx b/docs/models/components/observabilitywebhookdestination.mdx index 87113fcd2..39b02e18f 100644 --- a/docs/models/components/observabilitywebhookdestination.mdx +++ b/docs/models/components/observabilitywebhookdestination.mdx @@ -6,19 +6,19 @@ title: "ObservabilityWebhookDestination" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `BroadcastGenerationCost` | `bool` | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `bool` | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `bool` | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `Config` | [components.ObservabilityWebhookDestinationConfig](../../models/components/observabilitywebhookdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `Name` | `*string` | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityWebhookDestinationType](../../models/components/observabilitywebhookdestinationtype.mdx) | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `APIKeyHashes` | []`string` | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `BroadcastGenerationCost` | `bool` | ✅ | When true, include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `bool` | ✅ | When true, include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `bool` | ✅ | When true, include request-context generation metadata. | false | +| `Config` | [components.ObservabilityWebhookDestinationConfig](../../models/components/observabilitywebhookdestinationconfig.mdx) | ✅ | N/A | | +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `Enabled` | `bool` | ✅ | Whether this destination is currently enabled. | true | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `ID` | `string` | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `Name` | `*string` | ✅ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `bool` | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegion](../../models/components/observabilitydataregion.mdx) | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `SamplingRate` | `float64` | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `Type` | [components.ObservabilityWebhookDestinationType](../../models/components/observabilitywebhookdestinationtype.mdx) | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/observabilitywebhookdestinationconfig.mdx b/docs/models/components/observabilitywebhookdestinationconfig.mdx index 330f8522f..297308b72 100644 --- a/docs/models/components/observabilitywebhookdestinationconfig.mdx +++ b/docs/models/components/observabilitywebhookdestinationconfig.mdx @@ -6,6 +6,6 @@ title: "ObservabilityWebhookDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Headers` | map[string]`string` | :heavy_minus_sign: | N/A | -| `Method` | [*components.Method](../../models/components/method.mdx) | :heavy_minus_sign: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Headers` | map[string]`string` | ➖ | N/A | +| `Method` | [*components.Method](../../models/components/method.mdx) | ➖ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifile.mdx b/docs/models/components/openaifile.mdx index ce6c7c6fa..2f564bbfd 100644 --- a/docs/models/components/openaifile.mdx +++ b/docs/models/components/openaifile.mdx @@ -9,11 +9,11 @@ A stored file in OpenAI's Files API shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileShape](../../models/components/openaifileshape.mdx) | :heavy_check_mark: | N/A | -| `Bytes` | `int64` | :heavy_check_mark: | N/A | -| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Object` | [components.OpenAIFileObject](../../models/components/openaifileobject.mdx) | :heavy_check_mark: | N/A | -| `Purpose` | [components.Purpose](../../models/components/purpose.mdx) | :heavy_check_mark: | N/A | -| `Status` | [components.OpenAIFileStatus](../../models/components/openaifilestatus.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.OpenAIFileShape](../../models/components/openaifileshape.mdx) | ✅ | N/A | +| `Bytes` | `int64` | ✅ | N/A | +| `CreatedAt` | `int64` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Object` | [components.OpenAIFileObject](../../models/components/openaifileobject.mdx) | ✅ | N/A | +| `Purpose` | [components.Purpose](../../models/components/purpose.mdx) | ✅ | N/A | +| `Status` | [components.OpenAIFileStatus](../../models/components/openaifilestatus.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifiledeleted.mdx b/docs/models/components/openaifiledeleted.mdx index 5e9e8bb9a..1636294f7 100644 --- a/docs/models/components/openaifiledeleted.mdx +++ b/docs/models/components/openaifiledeleted.mdx @@ -9,7 +9,7 @@ Deletion result in OpenAI's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileDeletedShape](../../models/components/openaifiledeletedshape.mdx) | :heavy_check_mark: | N/A | -| `Deleted` | `bool` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Object` | [components.OpenAIFileDeletedObject](../../models/components/openaifiledeletedobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.OpenAIFileDeletedShape](../../models/components/openaifiledeletedshape.mdx) | ✅ | N/A | +| `Deleted` | `bool` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Object` | [components.OpenAIFileDeletedObject](../../models/components/openaifiledeletedobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifilelist.mdx b/docs/models/components/openaifilelist.mdx index 4222fe91c..fe43387a0 100644 --- a/docs/models/components/openaifilelist.mdx +++ b/docs/models/components/openaifilelist.mdx @@ -9,9 +9,9 @@ A page of files in OpenAI's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileListShape](../../models/components/openaifilelistshape.mdx) | :heavy_check_mark: | N/A | -| `Data` | [][components.OpenAIFile](../../models/components/openaifile.mdx) | :heavy_check_mark: | N/A | -| `FirstID` | `*string` | :heavy_check_mark: | N/A | -| `HasMore` | `bool` | :heavy_check_mark: | N/A | -| `LastID` | `*string` | :heavy_check_mark: | N/A | -| `Object` | [components.OpenAIFileListObject](../../models/components/openaifilelistobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.OpenAIFileListShape](../../models/components/openaifilelistshape.mdx) | ✅ | N/A | +| `Data` | [][components.OpenAIFile](../../models/components/openaifile.mdx) | ✅ | N/A | +| `FirstID` | `*string` | ✅ | N/A | +| `HasMore` | `bool` | ✅ | N/A | +| `LastID` | `*string` | ✅ | N/A | +| `Object` | [components.OpenAIFileListObject](../../models/components/openaifilelistobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsecustomtoolcall.mdx b/docs/models/components/openairesponsecustomtoolcall.mdx index 4a6a8d1a0..072ffa95a 100644 --- a/docs/models/components/openairesponsecustomtoolcall.mdx +++ b/docs/models/components/openairesponsecustomtoolcall.mdx @@ -6,10 +6,10 @@ title: "OpenAIResponseCustomToolCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Input` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Type` | [components.OpenAIResponseCustomToolCallType](../../models/components/openairesponsecustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Input` | `string` | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Type` | [components.OpenAIResponseCustomToolCallType](../../models/components/openairesponsecustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/openairesponsecustomtoolcalloutput.mdx b/docs/models/components/openairesponsecustomtoolcalloutput.mdx index 726441b3b..cbc1368d9 100644 --- a/docs/models/components/openairesponsecustomtoolcalloutput.mdx +++ b/docs/models/components/openairesponsecustomtoolcalloutput.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseCustomToolCallOutput" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../../models/components/openairesponsecustomtoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponseCustomToolCallOutputType](../../models/components/openairesponsecustomtoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | +| `ID` | `*string` | ➖ | N/A | +| `Output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../../models/components/openairesponsecustomtoolcalloutputoutput2.mdx) | ✅ | N/A | +| `Type` | [components.OpenAIResponseCustomToolCallOutputType](../../models/components/openairesponsecustomtoolcalloutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsefunctiontoolcall.mdx b/docs/models/components/openairesponsefunctiontoolcall.mdx index ebfcfef97..1c005d874 100644 --- a/docs/models/components/openairesponsefunctiontoolcall.mdx +++ b/docs/models/components/openairesponsefunctiontoolcall.mdx @@ -6,13 +6,13 @@ title: "OpenAIResponseFunctionToolCall" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `SubagentID` | `*string` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `SubagentItems` | [][components.OpenAIResponseFunctionToolCallSubagentItem](../../models/components/openairesponsefunctiontoolcallsubagentitem.mdx) | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | -| `Type` | [components.OpenAIResponseFunctionToolCallType](../../models/components/openairesponsefunctiontoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | | +| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ➖ | N/A | completed | +| `SubagentID` | `*string` | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `SubagentItems` | [][components.OpenAIResponseFunctionToolCallSubagentItem](../../models/components/openairesponsefunctiontoolcallsubagentitem.mdx) | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | +| `Type` | [components.OpenAIResponseFunctionToolCallType](../../models/components/openairesponsefunctiontoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/openairesponsefunctiontoolcalloutput.mdx b/docs/models/components/openairesponsefunctiontoolcalloutput.mdx index e464d154c..6174bf4b6 100644 --- a/docs/models/components/openairesponsefunctiontoolcalloutput.mdx +++ b/docs/models/components/openairesponsefunctiontoolcalloutput.mdx @@ -6,8 +6,8 @@ title: "OpenAIResponseFunctionToolCallOutput" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../../models/components/openairesponsefunctiontoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.OpenAIResponseFunctionToolCallOutputType](../../models/components/openairesponsefunctiontoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../../models/components/openairesponsefunctiontoolcalloutputoutput2.mdx) | ✅ | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | +| `Type` | [components.OpenAIResponseFunctionToolCallOutputType](../../models/components/openairesponsefunctiontoolcalloutputtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/openairesponsefunctiontoolcallsubagentitem.mdx b/docs/models/components/openairesponsefunctiontoolcallsubagentitem.mdx index 6d1d9b61b..d293745ed 100644 --- a/docs/models/components/openairesponsefunctiontoolcallsubagentitem.mdx +++ b/docs/models/components/openairesponsefunctiontoolcallsubagentitem.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponseFunctionToolCallSubagentItem" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | `string` | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponseinputmessageitem.mdx b/docs/models/components/openairesponseinputmessageitem.mdx index 8d8a2353e..9bd3d0ad8 100644 --- a/docs/models/components/openairesponseinputmessageitem.mdx +++ b/docs/models/components/openairesponseinputmessageitem.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseInputMessageItem" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Content` | [][components.OpenAIResponseInputMessageItemContent](../../models/components/openairesponseinputmessageitemcontent.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Role` | [components.OpenAIResponseInputMessageItemRoleUnion](../../models/components/openairesponseinputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [*components.OpenAIResponseInputMessageItemType](../../models/components/openairesponseinputmessageitemtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Content` | [][components.OpenAIResponseInputMessageItemContent](../../models/components/openairesponseinputmessageitemcontent.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Role` | [components.OpenAIResponseInputMessageItemRoleUnion](../../models/components/openairesponseinputmessageitemroleunion.mdx) | ✅ | N/A | +| `Type` | [*components.OpenAIResponseInputMessageItemType](../../models/components/openairesponseinputmessageitemtype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsesrefusalcontent.mdx b/docs/models/components/openairesponsesrefusalcontent.mdx index e412ff668..4f6b357f1 100644 --- a/docs/models/components/openairesponsesrefusalcontent.mdx +++ b/docs/models/components/openairesponsesrefusalcontent.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponsesRefusalContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Refusal` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponsesRefusalContentType](../../models/components/openairesponsesrefusalcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Refusal` | `string` | ✅ | N/A | +| `Type` | [components.OpenAIResponsesRefusalContentType](../../models/components/openairesponsesrefusalcontenttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoice.mdx b/docs/models/components/openairesponsestoolchoice.mdx index cfeeb25de..849d433a6 100644 --- a/docs/models/components/openairesponsestoolchoice.mdx +++ b/docs/models/components/openairesponsestoolchoice.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoice" | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Type` | [components.Type](../../models/components/type.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.Type](../../models/components/type.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoiceapplypatch.mdx b/docs/models/components/openairesponsestoolchoiceapplypatch.mdx index d37e00a52..5485631f4 100644 --- a/docs/models/components/openairesponsestoolchoiceapplypatch.mdx +++ b/docs/models/components/openairesponsestoolchoiceapplypatch.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceApplyPatch" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../../models/components/openairesponsestoolchoicetypeapplypatch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../../models/components/openairesponsestoolchoicetypeapplypatch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoicefunction.mdx b/docs/models/components/openairesponsestoolchoicefunction.mdx index f9607fb9b..831b77006 100644 --- a/docs/models/components/openairesponsestoolchoicefunction.mdx +++ b/docs/models/components/openairesponsestoolchoicefunction.mdx @@ -6,5 +6,5 @@ title: "OpenAIResponsesToolChoiceFunction" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponsesToolChoiceTypeFunction](../../models/components/openairesponsestoolchoicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Name` | `string` | ✅ | N/A | +| `Type` | [components.OpenAIResponsesToolChoiceTypeFunction](../../models/components/openairesponsestoolchoicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoiceshell.mdx b/docs/models/components/openairesponsestoolchoiceshell.mdx index f964fb9c6..ab5536f78 100644 --- a/docs/models/components/openairesponsestoolchoiceshell.mdx +++ b/docs/models/components/openairesponsestoolchoiceshell.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceShell" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OpenAIResponsesToolChoiceTypeShell](../../models/components/openairesponsestoolchoicetypeshell.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponsesToolChoiceTypeShell](../../models/components/openairesponsestoolchoicetypeshell.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openresponsescreatedevent.mdx b/docs/models/components/openresponsescreatedevent.mdx index 50c252482..d70315a60 100644 --- a/docs/models/components/openresponsescreatedevent.mdx +++ b/docs/models/components/openresponsescreatedevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is created | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.OpenResponsesCreatedEventType](../../models/components/openresponsescreatedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.OpenResponsesCreatedEventType](../../models/components/openresponsescreatedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/openresponseserrorfield.mdx b/docs/models/components/openresponseserrorfield.mdx index 89bbef4fb..fc3ef43a7 100644 --- a/docs/models/components/openresponseserrorfield.mdx +++ b/docs/models/components/openresponseserrorfield.mdx @@ -9,6 +9,6 @@ Error of a failed response; `metadata` carries OpenRouter-specific details. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Code` | [components.CodeEnum](../../models/components/codeenum.mdx) | :heavy_check_mark: | N/A | | -| `Message` | `string` | :heavy_check_mark: | N/A | | -| `Metadata` | [*components.OpenResponsesErrorMetadata](../../models/components/openresponseserrormetadata.mdx) | :heavy_minus_sign: | OpenRouter-specific details of a failed response, such as the alignment object of an alignment error. | \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
} | \ No newline at end of file +| `Code` | [components.CodeEnum](../../models/components/codeenum.mdx) | ✅ | N/A | | +| `Message` | `string` | ✅ | N/A | | +| `Metadata` | [*components.OpenResponsesErrorMetadata](../../models/components/openresponseserrormetadata.mdx) | ➖ | OpenRouter-specific details of a failed response, such as the alignment object of an alignment error. | \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
} | \ No newline at end of file diff --git a/docs/models/components/openresponseserrormetadata.mdx b/docs/models/components/openresponseserrormetadata.mdx index 9203693a8..d7d330430 100644 --- a/docs/models/components/openresponseserrormetadata.mdx +++ b/docs/models/components/openresponseserrormetadata.mdx @@ -9,4 +9,4 @@ OpenRouter-specific details of a failed response, such as the alignment object o | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Alignment` | [*components.OpenResponsesErrorMetadataAlignment](../../models/components/openresponseserrormetadataalignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | \ No newline at end of file +| `Alignment` | [*components.OpenResponsesErrorMetadataAlignment](../../models/components/openresponseserrormetadataalignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | \ No newline at end of file diff --git a/docs/models/components/openresponseserrormetadataalignment.mdx b/docs/models/components/openresponseserrormetadataalignment.mdx index 70a97f45a..528e65235 100644 --- a/docs/models/components/openresponseserrormetadataalignment.mdx +++ b/docs/models/components/openresponseserrormetadataalignment.mdx @@ -9,5 +9,5 @@ Beta. The result of the alignment plugin for this request; the shape may change. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Calls` | [][components.AlignmentCallRecord](../../models/components/alignmentcallrecord.mdx) | :heavy_check_mark: | One record per evaluated assistant message of the request, in the order the messages were produced. | -| `Rejected` | [*components.AlignmentRejected](../../models/components/alignmentrejected.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Calls` | [][components.AlignmentCallRecord](../../models/components/alignmentcallrecord.mdx) | ✅ | One record per evaluated assistant message of the request, in the order the messages were produced. | +| `Rejected` | [*components.AlignmentRejected](../../models/components/alignmentrejected.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/openresponsesinprogressevent.mdx b/docs/models/components/openresponsesinprogressevent.mdx index e08c1e18e..e5a533e82 100644 --- a/docs/models/components/openresponsesinprogressevent.mdx +++ b/docs/models/components/openresponsesinprogressevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is in progress | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.OpenResponsesInProgressEventType](../../models/components/openresponsesinprogresseventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.OpenResponsesInProgressEventType](../../models/components/openresponsesinprogresseventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/openresponsesresult.mdx b/docs/models/components/openresponsesresult.mdx index 70ce3d7e1..a4a774f3d 100644 --- a/docs/models/components/openresponsesresult.mdx +++ b/docs/models/components/openresponsesresult.mdx @@ -9,41 +9,41 @@ Complete non-streaming response from the Responses API | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Background` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `CompletedAt` | `*int64` | :heavy_check_mark: | N/A | | -| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | | -| `Error` | [*components.OpenResponsesErrorField](../../models/components/openresponseserrorfield.mdx) | :heavy_check_mark: | Error of a failed response; `metadata` carries OpenRouter-specific details. | \{
"code": "server_error",
"message": "Alignment plugin: the reply could not be evaluated: evaluator_error",
"metadata": \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
}
} | -| `FrequencyPenalty` | `*float64` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `IncompleteDetails` | [*components.IncompleteDetails](../../models/components/incompletedetails.mdx) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | -| `Instructions` | [*components.BaseInputsUnion](../../models/components/baseinputsunion.mdx) | :heavy_check_mark: | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | -| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Metadata` | map[string]`string` | :heavy_check_mark: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Object` | [components.OpenResponsesResultObject](../../models/components/openresponsesresultobject.mdx) | :heavy_check_mark: | N/A | | -| `Output` | [][components.OutputItems](../../models/components/outputitems.mdx) | :heavy_check_mark: | N/A | | -| `OutputText` | `*string` | :heavy_minus_sign: | N/A | | -| `ParallelToolCalls` | `bool` | :heavy_check_mark: | N/A | | -| `PresencePenalty` | `*float64` | :heavy_check_mark: | N/A | | -| `PreviousResponseID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `Reasoning` | optionalnullable.OptionalNullable[[components.BaseReasoningConfig](../../models/components/basereasoningconfig.mdx)] | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | -| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | [components.OpenAIResponsesResponseStatus](../../models/components/openairesponsesresponsestatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Store` | `*bool` | :heavy_minus_sign: | N/A | | -| `Temperature` | `*float64` | :heavy_check_mark: | N/A | | -| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `ToolChoice` | [components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | :heavy_check_mark: | N/A | auto | -| `Tools` | [][components.OpenResponsesResultToolUnion](../../models/components/openresponsesresulttoolunion.mdx) | :heavy_check_mark: | N/A | | -| `TopLogprobs` | `*int64` | :heavy_minus_sign: | N/A | | -| `TopP` | `*float64` | :heavy_check_mark: | N/A | | -| `Truncation` | optionalnullable.OptionalNullable[[components.Truncation](../../models/components/truncation.mdx)] | :heavy_minus_sign: | N/A | auto | -| `Usage` | optionalnullable.OptionalNullable[[components.Usage](../../models/components/usage.mdx)] | :heavy_minus_sign: | Token usage information for the response | \{
"cost": 0.0012,
"cost_details": \{
"upstream_inference_cost": null,
"upstream_inference_input_cost": 0.0008,
"upstream_inference_output_cost": 0.0004
},
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
} | -| `User` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Alignment` | [*components.Alignment](../../models/components/alignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | -| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file +| `Background` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `CompletedAt` | `*int64` | ✅ | N/A | | +| `CreatedAt` | `int64` | ✅ | N/A | | +| `Error` | [*components.OpenResponsesErrorField](../../models/components/openresponseserrorfield.mdx) | ✅ | Error of a failed response; `metadata` carries OpenRouter-specific details. | \{
"code": "server_error",
"message": "Alignment plugin: the reply could not be evaluated: evaluator_error",
"metadata": \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
}
} | +| `FrequencyPenalty` | `*float64` | ✅ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `IncompleteDetails` | [*components.IncompleteDetails](../../models/components/incompletedetails.mdx) | ✅ | N/A | \{
"reason": "max_output_tokens"
} | +| `Instructions` | [*components.BaseInputsUnion](../../models/components/baseinputsunion.mdx) | ✅ | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | +| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | +| `Metadata` | map[string]`string` | ✅ | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | +| `Model` | `string` | ✅ | N/A | | +| `Object` | [components.OpenResponsesResultObject](../../models/components/openresponsesresultobject.mdx) | ✅ | N/A | | +| `Output` | [][components.OutputItems](../../models/components/outputitems.mdx) | ✅ | N/A | | +| `OutputText` | `*string` | ➖ | N/A | | +| `ParallelToolCalls` | `bool` | ✅ | N/A | | +| `PresencePenalty` | `*float64` | ✅ | N/A | | +| `PreviousResponseID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `Reasoning` | optionalnullable.OptionalNullable[[components.BaseReasoningConfig](../../models/components/basereasoningconfig.mdx)] | ➖ | N/A | \{
"effort": "medium",
"summary": "auto"
} | +| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ServiceTier` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Status` | [components.OpenAIResponsesResponseStatus](../../models/components/openairesponsesresponsestatus.mdx) | ✅ | N/A | completed | +| `Store` | `*bool` | ➖ | N/A | | +| `Temperature` | `*float64` | ✅ | N/A | | +| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `ToolChoice` | [components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | ✅ | N/A | auto | +| `Tools` | [][components.OpenResponsesResultToolUnion](../../models/components/openresponsesresulttoolunion.mdx) | ✅ | N/A | | +| `TopLogprobs` | `*int64` | ➖ | N/A | | +| `TopP` | `*float64` | ✅ | N/A | | +| `Truncation` | optionalnullable.OptionalNullable[[components.Truncation](../../models/components/truncation.mdx)] | ➖ | N/A | auto | +| `Usage` | optionalnullable.OptionalNullable[[components.Usage](../../models/components/usage.mdx)] | ➖ | Token usage information for the response | \{
"cost": 0.0012,
"cost_details": \{
"upstream_inference_cost": null,
"upstream_inference_input_cost": 0.0008,
"upstream_inference_output_cost": 0.0004
},
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
} | +| `User` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Alignment` | [*components.Alignment](../../models/components/alignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | +| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file diff --git a/docs/models/components/openresponsesresulttoolfunction.mdx b/docs/models/components/openresponsesresulttoolfunction.mdx index d1ed93467..c35034136 100644 --- a/docs/models/components/openresponsesresulttoolfunction.mdx +++ b/docs/models/components/openresponsesresulttoolfunction.mdx @@ -9,10 +9,10 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.OpenResponsesResultType](../../models/components/openresponsesresulttype.mdx) | :heavy_check_mark: | N/A | | -| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Parameters` | map[string]`any` | ✅ | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `Type` | [components.OpenResponsesResultType](../../models/components/openresponsesresulttype.mdx) | ✅ | N/A | | +| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/components/openrouterfile.mdx b/docs/models/components/openrouterfile.mdx index ec87a6284..b9110f68f 100644 --- a/docs/models/components/openrouterfile.mdx +++ b/docs/models/components/openrouterfile.mdx @@ -9,11 +9,11 @@ A stored file in the OpenRouter superset shape: Anthropic-shaped, plus OpenRoute | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileShape](../../models/components/openrouterfileshape.mdx) | :heavy_check_mark: | N/A | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | -| `Downloadable` | `bool` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `MimeType` | `string` | :heavy_check_mark: | N/A | -| `SizeBytes` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenRouterFileType](../../models/components/openrouterfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.OpenRouterFileShape](../../models/components/openrouterfileshape.mdx) | ✅ | N/A | +| `CreatedAt` | `string` | ✅ | N/A | +| `Downloadable` | `bool` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `MimeType` | `string` | ✅ | N/A | +| `SizeBytes` | `int64` | ✅ | N/A | +| `Type` | [components.OpenRouterFileType](../../models/components/openrouterfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openrouterfiledeleted.mdx b/docs/models/components/openrouterfiledeleted.mdx index 16d6aea4c..d1046da35 100644 --- a/docs/models/components/openrouterfiledeleted.mdx +++ b/docs/models/components/openrouterfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in the OpenRouter shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileDeletedShape](../../models/components/openrouterfiledeletedshape.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenRouterFileDeletedType](../../models/components/openrouterfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.OpenRouterFileDeletedShape](../../models/components/openrouterfiledeletedshape.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Type` | [components.OpenRouterFileDeletedType](../../models/components/openrouterfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openrouterfilelist.mdx b/docs/models/components/openrouterfilelist.mdx index 8b4ef8de0..2a6bef713 100644 --- a/docs/models/components/openrouterfilelist.mdx +++ b/docs/models/components/openrouterfilelist.mdx @@ -9,9 +9,9 @@ A page of files in the OpenRouter shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileListShape](../../models/components/openrouterfilelistshape.mdx) | :heavy_check_mark: | N/A | -| `Cursor` | `*string` | :heavy_check_mark: | Opaque cursor for the next page; null when there are no more results. | -| `Data` | [][components.OpenRouterFile](../../models/components/openrouterfile.mdx) | :heavy_check_mark: | N/A | -| `FirstID` | `*string` | :heavy_check_mark: | N/A | -| `HasMore` | `bool` | :heavy_check_mark: | N/A | -| `LastID` | `*string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Shape` | [components.OpenRouterFileListShape](../../models/components/openrouterfilelistshape.mdx) | ✅ | N/A | +| `Cursor` | `*string` | ✅ | Opaque cursor for the next page; null when there are no more results. | +| `Data` | [][components.OpenRouterFile](../../models/components/openrouterfile.mdx) | ✅ | N/A | +| `FirstID` | `*string` | ✅ | N/A | +| `HasMore` | `bool` | ✅ | N/A | +| `LastID` | `*string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/openroutermetadata.mdx b/docs/models/components/openroutermetadata.mdx index 79f760106..21e5e404b 100644 --- a/docs/models/components/openroutermetadata.mdx +++ b/docs/models/components/openroutermetadata.mdx @@ -6,14 +6,14 @@ title: "OpenRouterMetadata" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Attempt` | `int64` | :heavy_check_mark: | N/A | | -| `Attempts` | [][components.RouterAttempt](../../models/components/routerattempt.mdx) | :heavy_minus_sign: | N/A | | -| `Endpoints` | [components.EndpointsMetadata](../../models/components/endpointsmetadata.mdx) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | -| `GenerationTime` | `*int64` | :heavy_minus_sign: | Milliseconds measured for the generation, from dispatching the upstream request until its response body ended. Divide the completion token count by this for throughput. Absent when no upstream request was dispatched. | 2016 | -| `IsBYOK` | `bool` | :heavy_check_mark: | N/A | | -| `Params` | [*components.RouterParams](../../models/components/routerparams.mdx) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | -| `Pipeline` | [][components.PipelineStage](../../models/components/pipelinestage.mdx) | :heavy_minus_sign: | N/A | | -| `Region` | `*string` | :heavy_check_mark: | N/A | | -| `Requested` | `string` | :heavy_check_mark: | N/A | | -| `Strategy` | [components.RoutingStrategy](../../models/components/routingstrategy.mdx) | :heavy_check_mark: | N/A | direct | -| `Summary` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Attempt` | `int64` | ✅ | N/A | | +| `Attempts` | [][components.RouterAttempt](../../models/components/routerattempt.mdx) | ➖ | N/A | | +| `Endpoints` | [components.EndpointsMetadata](../../models/components/endpointsmetadata.mdx) | ✅ | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | +| `GenerationTime` | `*int64` | ➖ | Milliseconds measured for the generation, from dispatching the upstream request until its response body ended. Divide the completion token count by this for throughput. Absent when no upstream request was dispatched. | 2016 | +| `IsBYOK` | `bool` | ✅ | N/A | | +| `Params` | [*components.RouterParams](../../models/components/routerparams.mdx) | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | +| `Pipeline` | [][components.PipelineStage](../../models/components/pipelinestage.mdx) | ➖ | N/A | | +| `Region` | `*string` | ✅ | N/A | | +| `Requested` | `string` | ✅ | N/A | | +| `Strategy` | [components.RoutingStrategy](../../models/components/routingstrategy.mdx) | ✅ | N/A | direct | +| `Summary` | `string` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/openrouterwebsearchservertool.mdx b/docs/models/components/openrouterwebsearchservertool.mdx index acd808b40..14a848074 100644 --- a/docs/models/components/openrouterwebsearchservertool.mdx +++ b/docs/models/components/openrouterwebsearchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `Type` | [components.OpenRouterWebSearchServerToolType](../../models/components/openrouterwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `Type` | [components.OpenRouterWebSearchServerToolType](../../models/components/openrouterwebsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/oranthropicbashtoolresult.mdx b/docs/models/components/oranthropicbashtoolresult.mdx index 2fdf42921..03e79850d 100644 --- a/docs/models/components/oranthropicbashtoolresult.mdx +++ b/docs/models/components/oranthropicbashtoolresult.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:bash` call executed in the OpenRouter sandbox (`engine: | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `Content` | map[string]`any` | :heavy_check_mark: | N/A | -| `Files` | [][components.ORAnthropicBashToolResultFile](../../models/components/oranthropicbashtoolresultfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ORAnthropicBashToolResultTypeOpenrouterBashToolResult](../../models/components/oranthropicbashtoolresulttypeopenrouterbashtoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `Content` | map[string]`any` | ✅ | N/A | +| `Files` | [][components.ORAnthropicBashToolResultFile](../../models/components/oranthropicbashtoolresultfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `ToolUseID` | `string` | ✅ | N/A | +| `Type` | [components.ORAnthropicBashToolResultTypeOpenrouterBashToolResult](../../models/components/oranthropicbashtoolresulttypeopenrouterbashtoolresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/oranthropicbashtoolresultfile.mdx b/docs/models/components/oranthropicbashtoolresultfile.mdx index b2a83c6c1..2755ed07d 100644 --- a/docs/models/components/oranthropicbashtoolresultfile.mdx +++ b/docs/models/components/oranthropicbashtoolresultfile.mdx @@ -6,9 +6,9 @@ title: "ORAnthropicBashToolResultFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ORAnthropicBashToolResultTypeContainerFileCitation](../../models/components/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `string` | ✅ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Type` | [components.ORAnthropicBashToolResultTypeContainerFileCitation](../../models/components/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/oranthropicservertooluseblock.mdx b/docs/models/components/oranthropicservertooluseblock.mdx index b6e5baacf..3582fc062 100644 --- a/docs/models/components/oranthropicservertooluseblock.mdx +++ b/docs/models/components/oranthropicservertooluseblock.mdx @@ -6,8 +6,8 @@ title: "ORAnthropicServerToolUseBlock" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Caller` | optionalnullable.OptionalNullable[[components.ORAnthropicNullableCaller](../../models/components/oranthropicnullablecaller.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "direct"
} | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Input` | `any` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.ORAnthropicServerToolUseBlockType](../../models/components/oranthropicservertooluseblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Caller` | optionalnullable.OptionalNullable[[components.ORAnthropicNullableCaller](../../models/components/oranthropicnullablecaller.mdx)] | ➖ | N/A | \{
"type": "direct"
} | +| `ID` | `string` | ✅ | N/A | | +| `Input` | `any` | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Type` | [components.ORAnthropicServerToolUseBlockType](../../models/components/oranthropicservertooluseblocktype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/oranthropicshelltoolresult.mdx b/docs/models/components/oranthropicshelltoolresult.mdx index e8ea31460..70221c8a9 100644 --- a/docs/models/components/oranthropicshelltoolresult.mdx +++ b/docs/models/components/oranthropicshelltoolresult.mdx @@ -9,8 +9,8 @@ Output of an `openrouter:shell` call executed in the OpenRouter sandbox | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `Content` | map[string]`any` | :heavy_check_mark: | N/A | -| `Files` | [][components.ORAnthropicShellToolResultFile](../../models/components/oranthropicshelltoolresultfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ORAnthropicShellToolResultTypeOpenrouterShellToolResult](../../models/components/oranthropicshelltoolresulttypeopenroutershelltoolresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `Content` | map[string]`any` | ✅ | N/A | +| `Files` | [][components.ORAnthropicShellToolResultFile](../../models/components/oranthropicshelltoolresultfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `ToolUseID` | `string` | ✅ | N/A | +| `Type` | [components.ORAnthropicShellToolResultTypeOpenrouterShellToolResult](../../models/components/oranthropicshelltoolresulttypeopenroutershelltoolresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/oranthropicshelltoolresultfile.mdx b/docs/models/components/oranthropicshelltoolresultfile.mdx index 6cb4fdaf3..21357d7eb 100644 --- a/docs/models/components/oranthropicshelltoolresultfile.mdx +++ b/docs/models/components/oranthropicshelltoolresultfile.mdx @@ -6,9 +6,9 @@ title: "ORAnthropicShellToolResultFile" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ORAnthropicShellToolResultTypeContainerFileCitation](../../models/components/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `string` | ✅ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Type` | [components.ORAnthropicShellToolResultTypeContainerFileCitation](../../models/components/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/organizationsettings.mdx b/docs/models/components/organizationsettings.mdx index 6e05ea3fe..b8152295f 100644 --- a/docs/models/components/organizationsettings.mdx +++ b/docs/models/components/organizationsettings.mdx @@ -6,5 +6,5 @@ title: "OrganizationSettings" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | -| `IsFilteredModelCatalogEnabled` | `bool` | :heavy_check_mark: | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file +| `ID` | `string` | ✅ | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | +| `IsFilteredModelCatalogEnabled` | `bool` | ✅ | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file diff --git a/docs/models/components/outcomeexit.mdx b/docs/models/components/outcomeexit.mdx index 4703060d6..428d204d0 100644 --- a/docs/models/components/outcomeexit.mdx +++ b/docs/models/components/outcomeexit.mdx @@ -6,6 +6,6 @@ title: "OutcomeExit" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `ExitCode` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeExit](../../models/components/typeexit.mdx) | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ExitCode` | `int64` | ✅ | N/A | +| `Type` | [components.TypeExit](../../models/components/typeexit.mdx) | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/outcometimeout.mdx b/docs/models/components/outcometimeout.mdx index 8b5a623f8..395651cd4 100644 --- a/docs/models/components/outcometimeout.mdx +++ b/docs/models/components/outcometimeout.mdx @@ -6,5 +6,5 @@ title: "OutcomeTimeout" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Type` | [components.TypeTimeout](../../models/components/typetimeout.mdx) | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | [components.TypeTimeout](../../models/components/typetimeout.mdx) | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputadvisorservertoolitem.mdx b/docs/models/components/outputadvisorservertoolitem.mdx index ddbedd13f..1e26be575 100644 --- a/docs/models/components/outputadvisorservertoolitem.mdx +++ b/docs/models/components/outputadvisorservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:advisor server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Advice` | `*string` | :heavy_minus_sign: | The advisor model's response (the advice text returned to the executor). | | -| `Error` | `*string` | :heavy_minus_sign: | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `InstanceName` | `*string` | :heavy_minus_sign: | Provider-safe function name of the specific advisor instance that produced this item (e.g. `openrouter_advisor__1`). Present only when more than one advisor tool is configured; omitted for the default single advisor. Echo this field back unchanged so the advisor's cross-request memory stays namespaced to the correct instance. This identity is positional: it is derived from the index of the advisor entry in the request `tools` array, so clients must keep the order of advisor tool entries stable across requests in a conversation. Reordering or inserting advisor entries shifts these names and causes each advisor's cross-request memory to be attributed to the wrong instance. | openrouter_advisor__1 | -| `Model` | `*string` | :heavy_minus_sign: | Slug of the advisor model that was consulted. | | -| `Prompt` | `*string` | :heavy_minus_sign: | The prompt the executor sent to the advisor. | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputAdvisorServerToolItemType](../../models/components/outputadvisorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Advice` | `*string` | ➖ | The advisor model's response (the advice text returned to the executor). | | +| `Error` | `*string` | ➖ | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | +| `ID` | `*string` | ➖ | N/A | | +| `InstanceName` | `*string` | ➖ | Provider-safe function name of the specific advisor instance that produced this item (e.g. `openrouter_advisor__1`). Present only when more than one advisor tool is configured; omitted for the default single advisor. Echo this field back unchanged so the advisor's cross-request memory stays namespaced to the correct instance. This identity is positional: it is derived from the index of the advisor entry in the request `tools` array, so clients must keep the order of advisor tool entries stable across requests in a conversation. Reordering or inserting advisor entries shifts these names and causes each advisor's cross-request memory to be attributed to the wrong instance. | openrouter_advisor__1 | +| `Model` | `*string` | ➖ | Slug of the advisor model that was consulted. | | +| `Prompt` | `*string` | ➖ | The prompt the executor sent to the advisor. | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputAdvisorServerToolItemType](../../models/components/outputadvisorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputapplypatchcallitem.mdx b/docs/models/components/outputapplypatchcallitem.mdx index fba577351..e5b5a4424 100644 --- a/docs/models/components/outputapplypatchcallitem.mdx +++ b/docs/models/components/outputapplypatchcallitem.mdx @@ -9,8 +9,8 @@ A native `apply_patch_call` output item matching OpenAI's Responses API shape. E | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `Status` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `Type` | [components.OutputApplyPatchCallItemType](../../models/components/outputapplypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | ✅ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `Status` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | +| `Type` | [components.OutputApplyPatchCallItemType](../../models/components/outputapplypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputapplypatchservertoolitem.mdx b/docs/models/components/outputapplypatchservertoolitem.mdx index cb6c958d8..b3dac23b2 100644 --- a/docs/models/components/outputapplypatchservertoolitem.mdx +++ b/docs/models/components/outputapplypatchservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:apply_patch server tool output item. The turn halts when validatio | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `*string` | :heavy_minus_sign: | N/A | | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Operation` | [*components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :heavy_minus_sign: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputApplyPatchServerToolItemType](../../models/components/outputapplypatchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CallID` | `*string` | ➖ | N/A | | +| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | ➖ | N/A | | +| `Operation` | [*components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | ➖ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputApplyPatchServerToolItemType](../../models/components/outputapplypatchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputbashservertoolitem.mdx b/docs/models/components/outputbashservertoolitem.mdx index 35ef9e315..255fd99f9 100644 --- a/docs/models/components/outputbashservertoolitem.mdx +++ b/docs/models/components/outputbashservertoolitem.mdx @@ -9,15 +9,15 @@ An openrouter:bash server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `CallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `Command` | `*string` | :heavy_minus_sign: | N/A | | -| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. A non-zero `exitCode` is a command failure, not a tool failure. | | -| `ExitCode` | `*int64` | :heavy_minus_sign: | N/A | | -| `Files` | [][components.OutputBashServerToolItemFile](../../models/components/outputbashservertoolitemfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Stderr` | `*string` | :heavy_minus_sign: | N/A | | -| `Stdout` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputBashServerToolItemTypeOpenrouterBash](../../models/components/outputbashservertoolitemtypeopenrouterbash.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `CallID` | optionalnullable.OptionalNullable[`string`] | ➖ | The model-generated tool call id from the originating turn. | | +| `Command` | `*string` | ➖ | N/A | | +| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `Error` | `*string` | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. A non-zero `exitCode` is a command failure, not a tool failure. | | +| `ExitCode` | `*int64` | ➖ | N/A | | +| `Files` | [][components.OutputBashServerToolItemFile](../../models/components/outputbashservertoolitemfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `ID` | `*string` | ➖ | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Stderr` | `*string` | ➖ | N/A | | +| `Stdout` | `*string` | ➖ | N/A | | +| `Type` | [components.OutputBashServerToolItemTypeOpenrouterBash](../../models/components/outputbashservertoolitemtypeopenrouterbash.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputbashservertoolitemfile.mdx b/docs/models/components/outputbashservertoolitemfile.mdx index 74172357e..f114a0ef6 100644 --- a/docs/models/components/outputbashservertoolitemfile.mdx +++ b/docs/models/components/outputbashservertoolitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputBashServerToolItemFile" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.OutputBashServerToolItemTypeContainerFileCitation](../../models/components/outputbashservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `string` | ✅ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Type` | [components.OutputBashServerToolItemTypeContainerFileCitation](../../models/components/outputbashservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputbrowseruseservertoolitem.mdx b/docs/models/components/outputbrowseruseservertoolitem.mdx index 25673e0fa..73b2a3cc0 100644 --- a/docs/models/components/outputbrowseruseservertoolitem.mdx +++ b/docs/models/components/outputbrowseruseservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:browser_use server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Action` | `*string` | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `ScreenshotB64` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputBrowserUseServerToolItemType](../../models/components/outputbrowseruseservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Action` | `*string` | ➖ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `ScreenshotB64` | `*string` | ➖ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputBrowserUseServerToolItemType](../../models/components/outputbrowseruseservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputcodeinterpretercallitem.mdx b/docs/models/components/outputcodeinterpretercallitem.mdx index 58d04ea03..6ef851a52 100644 --- a/docs/models/components/outputcodeinterpretercallitem.mdx +++ b/docs/models/components/outputcodeinterpretercallitem.mdx @@ -9,10 +9,10 @@ A code interpreter execution call with outputs | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Code` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ContainerID` | `*string` | :heavy_minus_sign: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Outputs` | optionalnullable.OptionalNullable[[][components.OutputCodeInterpreterCallItemOutput](../../models/components/outputcodeinterpretercallitemoutput.mdx)] | :heavy_minus_sign: | N/A | | -| `Status` | [components.OutputCodeInterpreterCallItemStatus](../../models/components/outputcodeinterpretercallitemstatus.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.OutputCodeInterpreterCallItemType](../../models/components/outputcodeinterpretercallitemtype.mdx) | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file +| `Code` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ContainerID` | `*string` | ➖ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Outputs` | optionalnullable.OptionalNullable[[][components.OutputCodeInterpreterCallItemOutput](../../models/components/outputcodeinterpretercallitemoutput.mdx)] | ➖ | N/A | | +| `Status` | [components.OutputCodeInterpreterCallItemStatus](../../models/components/outputcodeinterpretercallitemstatus.mdx) | ✅ | N/A | | +| `Type` | [components.OutputCodeInterpreterCallItemType](../../models/components/outputcodeinterpretercallitemtype.mdx) | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file diff --git a/docs/models/components/outputcodeinterpreterservertoolitem.mdx b/docs/models/components/outputcodeinterpreterservertoolitem.mdx index 43f758a57..1ca5247dc 100644 --- a/docs/models/components/outputcodeinterpreterservertoolitem.mdx +++ b/docs/models/components/outputcodeinterpreterservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:code_interpreter server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Code` | `*string` | :heavy_minus_sign: | N/A | | -| `ExitCode` | `*int64` | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Language` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Stderr` | `*string` | :heavy_minus_sign: | N/A | | -| `Stdout` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputCodeInterpreterServerToolItemType](../../models/components/outputcodeinterpreterservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Code` | `*string` | ➖ | N/A | | +| `ExitCode` | `*int64` | ➖ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Language` | `*string` | ➖ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Stderr` | `*string` | ➖ | N/A | | +| `Stdout` | `*string` | ➖ | N/A | | +| `Type` | [components.OutputCodeInterpreterServerToolItemType](../../models/components/outputcodeinterpreterservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputcomputercallitem.mdx b/docs/models/components/outputcomputercallitem.mdx index f63420774..c24b78165 100644 --- a/docs/models/components/outputcomputercallitem.mdx +++ b/docs/models/components/outputcomputercallitem.mdx @@ -6,9 +6,9 @@ title: "OutputComputerCallItem" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Action` | `any` | :heavy_minus_sign: | N/A | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `PendingSafetyChecks` | [][components.PendingSafetyCheck](../../models/components/pendingsafetycheck.mdx) | :heavy_check_mark: | N/A | -| `Status` | [components.OutputComputerCallItemStatus](../../models/components/outputcomputercallitemstatus.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.OutputComputerCallItemType](../../models/components/outputcomputercallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Action` | `any` | ➖ | N/A | +| `CallID` | `string` | ✅ | N/A | +| `ID` | `*string` | ➖ | N/A | +| `PendingSafetyChecks` | [][components.PendingSafetyCheck](../../models/components/pendingsafetycheck.mdx) | ✅ | N/A | +| `Status` | [components.OutputComputerCallItemStatus](../../models/components/outputcomputercallitemstatus.mdx) | ✅ | N/A | +| `Type` | [components.OutputComputerCallItemType](../../models/components/outputcomputercallitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputcustomtoolcallitem.mdx b/docs/models/components/outputcustomtoolcallitem.mdx index c6672c38b..018f82a9f 100644 --- a/docs/models/components/outputcustomtoolcallitem.mdx +++ b/docs/models/components/outputcustomtoolcallitem.mdx @@ -9,11 +9,11 @@ A call to a custom (freeform-grammar) tool created by the model — distinct fro | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Input` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.OutputCustomToolCallItemStatus](../../models/components/outputcustomtoolcallitemstatus.mdx) | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputCustomToolCallItemType](../../models/components/outputcustomtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Input` | `string` | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.OutputCustomToolCallItemStatus](../../models/components/outputcustomtoolcallitemstatus.mdx) | ➖ | N/A | | +| `Type` | [components.OutputCustomToolCallItemType](../../models/components/outputcustomtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputdatetimeitem.mdx b/docs/models/components/outputdatetimeitem.mdx index c6ee2019e..bbe03919a 100644 --- a/docs/models/components/outputdatetimeitem.mdx +++ b/docs/models/components/outputdatetimeitem.mdx @@ -9,9 +9,9 @@ An openrouter:datetime server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Datetime` | `string` | :heavy_check_mark: | ISO 8601 datetime string | | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Timezone` | `string` | :heavy_check_mark: | IANA timezone name | | -| `Type` | [components.OutputDatetimeItemType](../../models/components/outputdatetimeitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Datetime` | `string` | ✅ | ISO 8601 datetime string | | +| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | ➖ | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Timezone` | `string` | ✅ | IANA timezone name | | +| `Type` | [components.OutputDatetimeItemType](../../models/components/outputdatetimeitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesearchcallitem.mdx b/docs/models/components/outputfilesearchcallitem.mdx index 7ec3d6c62..038cf5977 100644 --- a/docs/models/components/outputfilesearchcallitem.mdx +++ b/docs/models/components/outputfilesearchcallitem.mdx @@ -6,7 +6,7 @@ title: "OutputFileSearchCallItem" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Queries` | []`string` | :heavy_check_mark: | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFileSearchCallItemType](../../models/components/outputfilesearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | | +| `Queries` | []`string` | ✅ | N/A | | +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputFileSearchCallItemType](../../models/components/outputfilesearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesearchservertoolitem.mdx b/docs/models/components/outputfilesearchservertoolitem.mdx index 74dcebbee..891f28346 100644 --- a/docs/models/components/outputfilesearchservertoolitem.mdx +++ b/docs/models/components/outputfilesearchservertoolitem.mdx @@ -9,7 +9,7 @@ An openrouter:file_search server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Queries` | []`string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFileSearchServerToolItemType](../../models/components/outputfilesearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `*string` | ➖ | N/A | | +| `Queries` | []`string` | ➖ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputFileSearchServerToolItemType](../../models/components/outputfilesearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesservertoolitem.mdx b/docs/models/components/outputfilesservertoolitem.mdx index e960931cb..7e33f0a35 100644 --- a/docs/models/components/outputfilesservertoolitem.mdx +++ b/docs/models/components/outputfilesservertoolitem.mdx @@ -9,13 +9,13 @@ An openrouter:files server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `CallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `Error` | `*string` | :heavy_minus_sign: | Error message when the file operation failed. | | -| `FileID` | `*string` | :heavy_minus_sign: | The target file id supplied in the tool-call arguments. | | -| `Filename` | `*string` | :heavy_minus_sign: | The target filename supplied in the tool-call arguments. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Operation` | `*string` | :heavy_minus_sign: | The file operation performed (list, read, write, or edit). | | -| `Result` | `*string` | :heavy_minus_sign: | JSON-serialized result of the file operation. | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFilesServerToolItemType](../../models/components/outputfilesservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `CallID` | optionalnullable.OptionalNullable[`string`] | ➖ | The model-generated tool call id from the originating turn. | | +| `Error` | `*string` | ➖ | Error message when the file operation failed. | | +| `FileID` | `*string` | ➖ | The target file id supplied in the tool-call arguments. | | +| `Filename` | `*string` | ➖ | The target filename supplied in the tool-call arguments. | | +| `ID` | `*string` | ➖ | N/A | | +| `Operation` | `*string` | ➖ | The file operation performed (list, read, write, or edit). | | +| `Result` | `*string` | ➖ | JSON-serialized result of the file operation. | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputFilesServerToolItemType](../../models/components/outputfilesservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfunctioncallitem.mdx b/docs/models/components/outputfunctioncallitem.mdx index a71c13427..3a42a9e54 100644 --- a/docs/models/components/outputfunctioncallitem.mdx +++ b/docs/models/components/outputfunctioncallitem.mdx @@ -6,13 +6,13 @@ title: "OutputFunctionCallItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.OutputFunctionCallItemStatusUnion](../../models/components/outputfunctioncallitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputFunctionCallItemType](../../models/components/outputfunctioncallitemtype.mdx) | :heavy_check_mark: | N/A | | -| `SubagentID` | `*string` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `SubagentItems` | [][components.OutputFunctionCallItemSubagentItem](../../models/components/outputfunctioncallitemsubagentitem.mdx) | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | | +| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.OutputFunctionCallItemStatusUnion](../../models/components/outputfunctioncallitemstatusunion.mdx) | ➖ | N/A | | +| `Type` | [components.OutputFunctionCallItemType](../../models/components/outputfunctioncallitemtype.mdx) | ✅ | N/A | | +| `SubagentID` | `*string` | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `SubagentItems` | [][components.OutputFunctionCallItemSubagentItem](../../models/components/outputfunctioncallitemsubagentitem.mdx) | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | \ No newline at end of file diff --git a/docs/models/components/outputfunctioncallitemsubagentitem.mdx b/docs/models/components/outputfunctioncallitemsubagentitem.mdx index 2f3773d6f..ea9104111 100644 --- a/docs/models/components/outputfunctioncallitemsubagentitem.mdx +++ b/docs/models/components/outputfunctioncallitemsubagentitem.mdx @@ -6,5 +6,5 @@ title: "OutputFunctionCallItemSubagentItem" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | `string` | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputfusionservertoolitem.mdx b/docs/models/components/outputfusionservertoolitem.mdx index 5b48e67ff..43e7d9c82 100644 --- a/docs/models/components/outputfusionservertoolitem.mdx +++ b/docs/models/components/outputfusionservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:fusion server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Analysis` | [*components.FusionAnalysisResult](../../models/components/fusionanalysisresult.mdx) | :heavy_minus_sign: | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | -| `Error` | `*string` | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | -| `FailedModels` | [][components.FailedModel](../../models/components/failedmodel.mdx) | :heavy_minus_sign: | Models that were requested as part of the analysis panel but did not produce a response. Present when at least one requested analysis model failed. On a completed item the fusion result is still usable but was produced from a degraded panel; on a failed item it lists the panels that failed before the run stopped, so the caller can see which models were attempted even though no analysis was produced. | | -| `FailureReason` | `*string` | :heavy_minus_sign: | Typed failure reason when the fusion run failed. Possible values include: all_panels_failed, insufficient_credits, rate_limited, invalid_model, judge_not_valid_json, judge_schema_mismatch, judge_upstream_error, judge_empty_completion. The four analysis-stage codes keep their pre-rename `judge_` spelling so existing consumers keep matching. The consumer-cancellation code is `cancelled`. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Responses` | [][components.OutputFusionServerToolItemResponse](../../models/components/outputfusionservertoolitemresponse.mdx) | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | -| `Sources` | [][components.FusionSource](../../models/components/fusionsource.mdx) | :heavy_minus_sign: | Web pages the analysis panels and analyst retrieved via web search during this fusion run, deduplicated by URL across the whole run. Present when at least one model cited a source. | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFusionServerToolItemType](../../models/components/outputfusionservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Analysis` | [*components.FusionAnalysisResult](../../models/components/fusionanalysisresult.mdx) | ➖ | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | +| `Error` | `*string` | ➖ | Error message when the fusion run did not produce an analysis result. | | +| `FailedModels` | [][components.FailedModel](../../models/components/failedmodel.mdx) | ➖ | Models that were requested as part of the analysis panel but did not produce a response. Present when at least one requested analysis model failed. On a completed item the fusion result is still usable but was produced from a degraded panel; on a failed item it lists the panels that failed before the run stopped, so the caller can see which models were attempted even though no analysis was produced. | | +| `FailureReason` | `*string` | ➖ | Typed failure reason when the fusion run failed. Possible values include: all_panels_failed, insufficient_credits, rate_limited, invalid_model, judge_not_valid_json, judge_schema_mismatch, judge_upstream_error, judge_empty_completion. The four analysis-stage codes keep their pre-rename `judge_` spelling so existing consumers keep matching. The consumer-cancellation code is `cancelled`. | | +| `ID` | `*string` | ➖ | N/A | | +| `Responses` | [][components.OutputFusionServerToolItemResponse](../../models/components/outputfusionservertoolitemresponse.mdx) | ➖ | Analysis models that produced a response in this fusion run, with each model's full panel content. | | +| `Sources` | [][components.FusionSource](../../models/components/fusionsource.mdx) | ➖ | Web pages the analysis panels and analyst retrieved via web search during this fusion run, deduplicated by URL across the whole run. Present when at least one model cited a source. | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputFusionServerToolItemType](../../models/components/outputfusionservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfusionservertoolitemresponse.mdx b/docs/models/components/outputfusionservertoolitemresponse.mdx index 2c0dd46f2..fcf749faf 100644 --- a/docs/models/components/outputfusionservertoolitemresponse.mdx +++ b/docs/models/components/outputfusionservertoolitemresponse.mdx @@ -6,5 +6,5 @@ title: "OutputFusionServerToolItemResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Content` | `*string` | :heavy_minus_sign: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | `*string` | ➖ | N/A | +| `Model` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputimagegenerationcallitem.mdx b/docs/models/components/outputimagegenerationcallitem.mdx index 9bd9a25d8..e981d59c9 100644 --- a/docs/models/components/outputimagegenerationcallitem.mdx +++ b/docs/models/components/outputimagegenerationcallitem.mdx @@ -6,8 +6,8 @@ title: "OutputImageGenerationCallItem" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputImageGenerationCallItemType](../../models/components/outputimagegenerationcallitemtype.mdx) | :heavy_check_mark: | N/A | | -| `Prompt` | `*string` | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | | +| `Result` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputImageGenerationCallItemType](../../models/components/outputimagegenerationcallitemtype.mdx) | ✅ | N/A | | +| `Prompt` | `*string` | ➖ | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file diff --git a/docs/models/components/outputimagegenerationservertoolitem.mdx b/docs/models/components/outputimagegenerationservertoolitem.mdx index c6bb28069..954fded85 100644 --- a/docs/models/components/outputimagegenerationservertoolitem.mdx +++ b/docs/models/components/outputimagegenerationservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:image_generation server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `ImageB64` | `*string` | :heavy_minus_sign: | N/A | | -| `ImageURL` | `*string` | :heavy_minus_sign: | N/A | | -| `Prompt` | `*string` | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | -| `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | -| `RevisedPrompt` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputImageGenerationServerToolItemType](../../models/components/outputimagegenerationservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | ➖ | N/A | | +| `ImageB64` | `*string` | ➖ | N/A | | +| `ImageURL` | `*string` | ➖ | N/A | | +| `Prompt` | `*string` | ➖ | The prompt (possibly rewritten) that the image was generated from. | | +| `Result` | optionalnullable.OptionalNullable[`string`] | ➖ | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | +| `RevisedPrompt` | `*string` | ➖ | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputImageGenerationServerToolItemType](../../models/components/outputimagegenerationservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemapplypatchcall.mdx b/docs/models/components/outputitemapplypatchcall.mdx index 4c62e74ca..d5c69e9a7 100644 --- a/docs/models/components/outputitemapplypatchcall.mdx +++ b/docs/models/components/outputitemapplypatchcall.mdx @@ -6,9 +6,9 @@ title: "OutputItemApplyPatchCall" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `CreatedBy` | `*string` | :heavy_minus_sign: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Operation` | [components.Operation](../../models/components/operation.mdx) | :heavy_check_mark: | N/A | -| `Status` | [components.OutputItemApplyPatchCallStatus](../../models/components/outputitemapplypatchcallstatus.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.OutputItemApplyPatchCallType](../../models/components/outputitemapplypatchcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | +| `CreatedBy` | `*string` | ➖ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Operation` | [components.Operation](../../models/components/operation.mdx) | ✅ | N/A | +| `Status` | [components.OutputItemApplyPatchCallStatus](../../models/components/outputitemapplypatchcallstatus.mdx) | ✅ | N/A | +| `Type` | [components.OutputItemApplyPatchCallType](../../models/components/outputitemapplypatchcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputitemcodeinterpretercall.mdx b/docs/models/components/outputitemcodeinterpretercall.mdx index de3d8dfae..cc95c98cd 100644 --- a/docs/models/components/outputitemcodeinterpretercall.mdx +++ b/docs/models/components/outputitemcodeinterpretercall.mdx @@ -6,10 +6,10 @@ title: "OutputItemCodeInterpreterCall" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Code` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ContainerID` | `*string` | :heavy_minus_sign: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Outputs` | optionalnullable.OptionalNullable[[][components.OutputItemCodeInterpreterCallOutput](../../models/components/outputitemcodeinterpretercalloutput.mdx)] | :heavy_minus_sign: | N/A | | -| `Status` | [components.OutputItemCodeInterpreterCallStatus](../../models/components/outputitemcodeinterpretercallstatus.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.OutputItemCodeInterpreterCallType](../../models/components/outputitemcodeinterpretercalltype.mdx) | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"code": "print(\"hello\")",
"id": "ci_abc123",
"outputs": [
\{
"logs": "hello\n",
"type": "logs"
}
],
"status": "completed",
"type": "code_interpreter_call"
} | \ No newline at end of file +| `Code` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ContainerID` | `*string` | ➖ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Outputs` | optionalnullable.OptionalNullable[[][components.OutputItemCodeInterpreterCallOutput](../../models/components/outputitemcodeinterpretercalloutput.mdx)] | ➖ | N/A | | +| `Status` | [components.OutputItemCodeInterpreterCallStatus](../../models/components/outputitemcodeinterpretercallstatus.mdx) | ✅ | N/A | | +| `Type` | [components.OutputItemCodeInterpreterCallType](../../models/components/outputitemcodeinterpretercalltype.mdx) | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"code": "print(\"hello\")",
"id": "ci_abc123",
"outputs": [
\{
"logs": "hello\n",
"type": "logs"
}
],
"status": "completed",
"type": "code_interpreter_call"
} | \ No newline at end of file diff --git a/docs/models/components/outputitemcustomtoolcall.mdx b/docs/models/components/outputitemcustomtoolcall.mdx index d8aa4dc82..faa5250e8 100644 --- a/docs/models/components/outputitemcustomtoolcall.mdx +++ b/docs/models/components/outputitemcustomtoolcall.mdx @@ -6,11 +6,11 @@ title: "OutputItemCustomToolCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Input` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.OutputItemCustomToolCallStatus](../../models/components/outputitemcustomtoolcallstatus.mdx) | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputItemCustomToolCallType](../../models/components/outputitemcustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Input` | `string` | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.OutputItemCustomToolCallStatus](../../models/components/outputitemcustomtoolcallstatus.mdx) | ➖ | N/A | | +| `Type` | [components.OutputItemCustomToolCallType](../../models/components/outputitemcustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemfilesearchcall.mdx b/docs/models/components/outputitemfilesearchcall.mdx index 6f0348b5c..27056e4c2 100644 --- a/docs/models/components/outputitemfilesearchcall.mdx +++ b/docs/models/components/outputitemfilesearchcall.mdx @@ -6,7 +6,7 @@ title: "OutputItemFileSearchCall" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Queries` | []`string` | :heavy_check_mark: | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputItemFileSearchCallType](../../models/components/outputitemfilesearchcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | | +| `Queries` | []`string` | ✅ | N/A | | +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputItemFileSearchCallType](../../models/components/outputitemfilesearchcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemfunctioncall.mdx b/docs/models/components/outputitemfunctioncall.mdx index fe943658a..e90ac708e 100644 --- a/docs/models/components/outputitemfunctioncall.mdx +++ b/docs/models/components/outputitemfunctioncall.mdx @@ -6,11 +6,11 @@ title: "OutputItemFunctionCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `Async` | `*bool` | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.OutputItemFunctionCallStatusUnion](../../models/components/outputitemfunctioncallstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputItemFunctionCallType](../../models/components/outputitemfunctioncalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | | +| `Async` | `*bool` | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Namespace` | `*string` | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `Status` | [*components.OutputItemFunctionCallStatusUnion](../../models/components/outputitemfunctioncallstatusunion.mdx) | ➖ | N/A | | +| `Type` | [components.OutputItemFunctionCallType](../../models/components/outputitemfunctioncalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemimagegenerationcall.mdx b/docs/models/components/outputitemimagegenerationcall.mdx index 5f80bfc78..2785c635d 100644 --- a/docs/models/components/outputitemimagegenerationcall.mdx +++ b/docs/models/components/outputitemimagegenerationcall.mdx @@ -6,7 +6,7 @@ title: "OutputItemImageGenerationCall" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputItemImageGenerationCallType](../../models/components/outputitemimagegenerationcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | | +| `Result` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputItemImageGenerationCallType](../../models/components/outputitemimagegenerationcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemreasoning.mdx b/docs/models/components/outputitemreasoning.mdx index 73504d2cb..f94ebdb64 100644 --- a/docs/models/components/outputitemreasoning.mdx +++ b/docs/models/components/outputitemreasoning.mdx @@ -6,9 +6,9 @@ title: "OutputItemReasoning" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx) | :heavy_minus_sign: | N/A | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Status` | [*components.OutputItemReasoningStatusUnion](../../models/components/outputitemreasoningstatusunion.mdx) | :heavy_minus_sign: | N/A | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.OutputItemReasoningType](../../models/components/outputitemreasoningtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx) | ➖ | N/A | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Status` | [*components.OutputItemReasoningStatusUnion](../../models/components/outputitemreasoningstatusunion.mdx) | ➖ | N/A | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | +| `Type` | [components.OutputItemReasoningType](../../models/components/outputitemreasoningtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputitemwebsearchcall.mdx b/docs/models/components/outputitemwebsearchcall.mdx index bd9471ba5..36745cf13 100644 --- a/docs/models/components/outputitemwebsearchcall.mdx +++ b/docs/models/components/outputitemwebsearchcall.mdx @@ -6,8 +6,8 @@ title: "OutputItemWebSearchCall" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputItemWebSearchCallActionUnion](../../models/components/outputitemwebsearchcallactionunion.mdx) | :heavy_minus_sign: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputItemWebSearchCallTypeWebSearchCall](../../models/components/outputitemwebsearchcalltypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"action": \{
"query": "OpenAI API",
"type": "search"
},
"id": "search-abc123",
"status": "completed",
"type": "web_search_call"
} | \ No newline at end of file +| `Action` | [*components.OutputItemWebSearchCallActionUnion](../../models/components/outputitemwebsearchcallactionunion.mdx) | ➖ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputItemWebSearchCallTypeWebSearchCall](../../models/components/outputitemwebsearchcalltypewebsearchcall.mdx) | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"action": \{
"query": "OpenAI API",
"type": "search"
},
"id": "search-abc123",
"status": "completed",
"type": "web_search_call"
} | \ No newline at end of file diff --git a/docs/models/components/outputitemwebsearchcallactionfindinpage.mdx b/docs/models/components/outputitemwebsearchcallactionfindinpage.mdx index 3e19a88b5..baa51d90d 100644 --- a/docs/models/components/outputitemwebsearchcallactionfindinpage.mdx +++ b/docs/models/components/outputitemwebsearchcallactionfindinpage.mdx @@ -6,6 +6,6 @@ title: "OutputItemWebSearchCallActionFindInPage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Pattern` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OutputItemWebSearchCallTypeFindInPage](../../models/components/outputitemwebsearchcalltypefindinpage.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Pattern` | `string` | ✅ | N/A | +| `Type` | [components.OutputItemWebSearchCallTypeFindInPage](../../models/components/outputitemwebsearchcalltypefindinpage.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputitemwebsearchcallactionopenpage.mdx b/docs/models/components/outputitemwebsearchcallactionopenpage.mdx index c3cbcb821..b83771bb9 100644 --- a/docs/models/components/outputitemwebsearchcallactionopenpage.mdx +++ b/docs/models/components/outputitemwebsearchcallactionopenpage.mdx @@ -6,5 +6,5 @@ title: "OutputItemWebSearchCallActionOpenPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OutputItemWebSearchCallTypeOpenPage](../../models/components/outputitemwebsearchcalltypeopenpage.mdx) | :heavy_check_mark: | N/A | -| `URL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | [components.OutputItemWebSearchCallTypeOpenPage](../../models/components/outputitemwebsearchcalltypeopenpage.mdx) | ✅ | N/A | +| `URL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputitemwebsearchcallactionsearch.mdx b/docs/models/components/outputitemwebsearchcallactionsearch.mdx index 85374ce0f..69952e2aa 100644 --- a/docs/models/components/outputitemwebsearchcallactionsearch.mdx +++ b/docs/models/components/outputitemwebsearchcallactionsearch.mdx @@ -6,7 +6,7 @@ title: "OutputItemWebSearchCallActionSearch" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Queries` | []`string` | :heavy_minus_sign: | N/A | -| `Query` | `string` | :heavy_check_mark: | N/A | -| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputItemWebSearchCallTypeSearch](../../models/components/outputitemwebsearchcalltypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Queries` | []`string` | ➖ | N/A | +| `Query` | `string` | ✅ | N/A | +| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | ➖ | N/A | +| `Type` | [components.OutputItemWebSearchCallTypeSearch](../../models/components/outputitemwebsearchcalltypesearch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputmcpservertoolitem.mdx b/docs/models/components/outputmcpservertoolitem.mdx index bc7aa85c9..2277b8c4a 100644 --- a/docs/models/components/outputmcpservertoolitem.mdx +++ b/docs/models/components/outputmcpservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:mcp server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `ServerLabel` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `ToolName` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputMcpServerToolItemType](../../models/components/outputmcpservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `*string` | ➖ | N/A | | +| `ServerLabel` | `*string` | ➖ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `ToolName` | `*string` | ➖ | N/A | | +| `Type` | [components.OutputMcpServerToolItemType](../../models/components/outputmcpservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputmemoryservertoolitem.mdx b/docs/models/components/outputmemoryservertoolitem.mdx index 09b7e5ec3..29479ffee 100644 --- a/docs/models/components/outputmemoryservertoolitem.mdx +++ b/docs/models/components/outputmemoryservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:memory server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Action` | [*components.ActionEnum](../../models/components/actionenum.mdx) | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Key` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputMemoryServerToolItemType](../../models/components/outputmemoryservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | -| `Value` | `any` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Action` | [*components.ActionEnum](../../models/components/actionenum.mdx) | ➖ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Key` | `*string` | ➖ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputMemoryServerToolItemType](../../models/components/outputmemoryservertoolitemtype.mdx) | ✅ | N/A | | +| `Value` | `any` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputmessage.mdx b/docs/models/components/outputmessage.mdx index ce33cc76d..72eb97e11 100644 --- a/docs/models/components/outputmessage.mdx +++ b/docs/models/components/outputmessage.mdx @@ -6,9 +6,9 @@ title: "OutputMessage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.OutputMessageContent](../../models/components/outputmessagecontent.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessagePhaseUnion](../../models/components/outputmessagephaseunion.mdx)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.OutputMessageRole](../../models/components/outputmessagerole.mdx) | :heavy_check_mark: | N/A | -| `Status` | [*components.OutputMessageStatusUnion](../../models/components/outputmessagestatusunion.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputMessageType](../../models/components/outputmessagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [][components.OutputMessageContent](../../models/components/outputmessagecontent.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessagePhaseUnion](../../models/components/outputmessagephaseunion.mdx)] | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `Role` | [components.OutputMessageRole](../../models/components/outputmessagerole.mdx) | ✅ | N/A | +| `Status` | [*components.OutputMessageStatusUnion](../../models/components/outputmessagestatusunion.mdx) | ➖ | N/A | +| `Type` | [components.OutputMessageType](../../models/components/outputmessagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputmessageitem.mdx b/docs/models/components/outputmessageitem.mdx index 4a1ee6034..7c79b802a 100644 --- a/docs/models/components/outputmessageitem.mdx +++ b/docs/models/components/outputmessageitem.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.OutputMessageItemContent](../../models/components/outputmessageitemcontent.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessageItemPhaseUnion](../../models/components/outputmessageitemphaseunion.mdx)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.OutputMessageItemRole](../../models/components/outputmessageitemrole.mdx) | :heavy_check_mark: | N/A | -| `Status` | [*components.OutputMessageItemStatusUnion](../../models/components/outputmessageitemstatusunion.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputMessageItemType](../../models/components/outputmessageitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [][components.OutputMessageItemContent](../../models/components/outputmessageitemcontent.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessageItemPhaseUnion](../../models/components/outputmessageitemphaseunion.mdx)] | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `Role` | [components.OutputMessageItemRole](../../models/components/outputmessageitemrole.mdx) | ✅ | N/A | +| `Status` | [*components.OutputMessageItemStatusUnion](../../models/components/outputmessageitemstatusunion.mdx) | ➖ | N/A | +| `Type` | [components.OutputMessageItemType](../../models/components/outputmessageitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputreasoningitem.mdx b/docs/models/components/outputreasoningitem.mdx index 05843b636..be15ec38a 100644 --- a/docs/models/components/outputreasoningitem.mdx +++ b/docs/models/components/outputreasoningitem.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [*components.OutputReasoningItemStatusUnion](../../models/components/outputreasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.OutputReasoningItemType](../../models/components/outputreasoningitemtype.mdx) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | -| `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | ➖ | N/A | | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Status` | [*components.OutputReasoningItemStatusUnion](../../models/components/outputreasoningitemstatusunion.mdx) | ➖ | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | | +| `Type` | [components.OutputReasoningItemType](../../models/components/outputreasoningitemtype.mdx) | ✅ | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | +| `Signature` | optionalnullable.OptionalNullable[`string`] | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/components/outputsearchmodelsservertoolitem.mdx b/docs/models/components/outputsearchmodelsservertoolitem.mdx index 79a6ac995..d44b7b225 100644 --- a/docs/models/components/outputsearchmodelsservertoolitem.mdx +++ b/docs/models/components/outputsearchmodelsservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:experimental__search_models server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `*string` | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Query` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputSearchModelsServerToolItemType](../../models/components/outputsearchmodelsservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | `*string` | ➖ | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | +| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | ➖ | N/A | | +| `Query` | `*string` | ➖ | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputSearchModelsServerToolItemType](../../models/components/outputsearchmodelsservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcallitem.mdx b/docs/models/components/outputshellcallitem.mdx index e29cfed42..ce3cfdff2 100644 --- a/docs/models/components/outputshellcallitem.mdx +++ b/docs/models/components/outputshellcallitem.mdx @@ -9,9 +9,9 @@ A native `shell_call` output item matching OpenAI's Responses API shape. Emitted | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputShellCallItemAction](../../models/components/outputshellcallitemaction.mdx) | :heavy_minus_sign: | N/A | | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | -| `Type` | [components.OutputShellCallItemType](../../models/components/outputshellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Action` | [*components.OutputShellCallItemAction](../../models/components/outputshellcallitemaction.mdx) | ➖ | N/A | | +| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | +| `CallID` | `string` | ✅ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | +| `Type` | [components.OutputShellCallItemType](../../models/components/outputshellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcallitemaction.mdx b/docs/models/components/outputshellcallitemaction.mdx index c841bd3e5..37540134c 100644 --- a/docs/models/components/outputshellcallitemaction.mdx +++ b/docs/models/components/outputshellcallitemaction.mdx @@ -6,6 +6,6 @@ title: "OutputShellCallItemAction" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Commands` | []`string` | :heavy_check_mark: | N/A | -| `MaxOutputLength` | `*int64` | :heavy_check_mark: | N/A | -| `TimeoutMs` | `*int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Commands` | []`string` | ✅ | N/A | +| `MaxOutputLength` | `*int64` | ✅ | N/A | +| `TimeoutMs` | `*int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputshellcalloutputitem.mdx b/docs/models/components/outputshellcalloutputitem.mdx index 09ef848d1..5a4b9fd05 100644 --- a/docs/models/components/outputshellcalloutputitem.mdx +++ b/docs/models/components/outputshellcalloutputitem.mdx @@ -9,12 +9,12 @@ A native `shell_call_output` item matching OpenAI's Responses API shape. Carries | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'incomplete'` and an empty `output`; absent on a successful call. | | -| `Files` | [][components.OutputShellCallOutputItemFile](../../models/components/outputshellcalloutputitemfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | :heavy_check_mark: | N/A | | -| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | -| `Type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../../models/components/outputshellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | | +| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `Error` | `*string` | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'incomplete'` and an empty `output`; absent on a successful call. | | +| `Files` | [][components.OutputShellCallOutputItemFile](../../models/components/outputshellcalloutputitemfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `ID` | `string` | ✅ | N/A | | +| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | +| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | ✅ | N/A | | +| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | +| `Type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../../models/components/outputshellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcalloutputitemfile.mdx b/docs/models/components/outputshellcalloutputitemfile.mdx index 85ccb9970..c5858b81b 100644 --- a/docs/models/components/outputshellcalloutputitemfile.mdx +++ b/docs/models/components/outputshellcalloutputitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputShellCallOutputItemFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.OutputShellCallOutputItemTypeContainerFileCitation](../../models/components/outputshellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `string` | ✅ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Type` | [components.OutputShellCallOutputItemTypeContainerFileCitation](../../models/components/outputshellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputshellservertoolitem.mdx b/docs/models/components/outputshellservertoolitem.mdx index 1723c5f78..a5a626072 100644 --- a/docs/models/components/outputshellservertoolitem.mdx +++ b/docs/models/components/outputshellservertoolitem.mdx @@ -9,13 +9,13 @@ An openrouter:shell server tool output item | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputShellServerToolItemAction](../../models/components/outputshellservertoolitemaction.mdx) | :heavy_minus_sign: | N/A | | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `CallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. `output` is omitted when `error` is set. | | -| `Files` | [][components.OutputShellServerToolItemFile](../../models/components/outputshellservertoolitemfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | :heavy_minus_sign: | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputShellServerToolItemTypeOpenrouterShell](../../models/components/outputshellservertoolitemtypeopenroutershell.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Action` | [*components.OutputShellServerToolItemAction](../../models/components/outputshellservertoolitemaction.mdx) | ➖ | N/A | | +| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `CallID` | optionalnullable.OptionalNullable[`string`] | ➖ | The model-generated tool call id from the originating turn. | | +| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `Error` | `*string` | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. `output` is omitted when `error` is set. | | +| `Files` | [][components.OutputShellServerToolItemFile](../../models/components/outputshellservertoolitemfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `ID` | `*string` | ➖ | N/A | | +| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | ➖ | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputShellServerToolItemTypeOpenrouterShell](../../models/components/outputshellservertoolitemtypeopenroutershell.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellservertoolitemaction.mdx b/docs/models/components/outputshellservertoolitemaction.mdx index 2e748d553..9030fc37a 100644 --- a/docs/models/components/outputshellservertoolitemaction.mdx +++ b/docs/models/components/outputshellservertoolitemaction.mdx @@ -6,6 +6,6 @@ title: "OutputShellServerToolItemAction" | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `Commands` | []`string` | :heavy_check_mark: | N/A | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Commands` | []`string` | ✅ | N/A | +| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | +| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputshellservertoolitemfile.mdx b/docs/models/components/outputshellservertoolitemfile.mdx index a5dbf3cea..c3bbf58ca 100644 --- a/docs/models/components/outputshellservertoolitemfile.mdx +++ b/docs/models/components/outputshellservertoolitemfile.mdx @@ -6,9 +6,9 @@ title: "OutputShellServerToolItemFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.OutputShellServerToolItemTypeContainerFileCitation](../../models/components/outputshellservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `string` | ✅ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Type` | [components.OutputShellServerToolItemTypeContainerFileCitation](../../models/components/outputshellservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputsubagentservertoolitem.mdx b/docs/models/components/outputsubagentservertoolitem.mdx index 246183b42..cac1dcde3 100644 --- a/docs/models/components/outputsubagentservertoolitem.mdx +++ b/docs/models/components/outputsubagentservertoolitem.mdx @@ -9,14 +9,14 @@ An openrouter:subagent server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `*string` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The `call_id` of the tool call that spawned this subagent. This id will also be included as the `subagent_id` on any `function_call` items created by the subagent. This must be returned in the request so the `function_call` can be matched with the correct subagent. A suspended `in_progress` item is announced once and never re-emitted or terminally closed — completion arrives as a new item with the same `call_id`. | | -| `Error` | `*string` | :heavy_minus_sign: | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `InstanceName` | `*string` | :heavy_minus_sign: | Provider-safe function name of the specific subagent instance that produced this item (e.g. `openrouter_subagent__1`). Present only on items from non-default instances — the second and later subagent entries in the request `tools` array. The first (default) instance omits it, even when multiple subagents are configured. When a replayed item echoes this field back, the transcript rehydrates the call under that instance's tool. This identity is positional: it is derived from the index of the subagent entry in the request `tools` array, so keep the order of subagent entries stable across requests in a conversation. | openrouter_subagent__1 | -| `Model` | `*string` | :heavy_minus_sign: | Slug of the worker model that executed the task. | | -| `Name` | `*string` | :heavy_minus_sign: | Configured name of the subagent that executed the task (the `name` on its tool entry). Present only for named subagents; omitted for an unnamed (default) subagent. | summarizer | -| `Outcome` | `*string` | :heavy_minus_sign: | The worker model's result (the outcome text returned to the delegating model). | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `TaskDescription` | `*string` | :heavy_minus_sign: | The task description the delegating model sent to the worker. | | -| `TaskName` | `*string` | :heavy_minus_sign: | The short task identifier the delegating model supplied. | | -| `Type` | [components.OutputSubagentServerToolItemType](../../models/components/outputsubagentservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CallID` | `*string` | ➖ | EXPERIMENTAL — subject to change without notice. The `call_id` of the tool call that spawned this subagent. This id will also be included as the `subagent_id` on any `function_call` items created by the subagent. This must be returned in the request so the `function_call` can be matched with the correct subagent. A suspended `in_progress` item is announced once and never re-emitted or terminally closed — completion arrives as a new item with the same `call_id`. | | +| `Error` | `*string` | ➖ | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | +| `ID` | `*string` | ➖ | N/A | | +| `InstanceName` | `*string` | ➖ | Provider-safe function name of the specific subagent instance that produced this item (e.g. `openrouter_subagent__1`). Present only on items from non-default instances — the second and later subagent entries in the request `tools` array. The first (default) instance omits it, even when multiple subagents are configured. When a replayed item echoes this field back, the transcript rehydrates the call under that instance's tool. This identity is positional: it is derived from the index of the subagent entry in the request `tools` array, so keep the order of subagent entries stable across requests in a conversation. | openrouter_subagent__1 | +| `Model` | `*string` | ➖ | Slug of the worker model that executed the task. | | +| `Name` | `*string` | ➖ | Configured name of the subagent that executed the task (the `name` on its tool entry). Present only for named subagents; omitted for an unnamed (default) subagent. | summarizer | +| `Outcome` | `*string` | ➖ | The worker model's result (the outcome text returned to the delegating model). | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `TaskDescription` | `*string` | ➖ | The task description the delegating model sent to the worker. | | +| `TaskName` | `*string` | ➖ | The short task identifier the delegating model supplied. | | +| `Type` | [components.OutputSubagentServerToolItemType](../../models/components/outputsubagentservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputtexteditorservertoolitem.mdx b/docs/models/components/outputtexteditorservertoolitem.mdx index 039f5e00c..05e82f1cb 100644 --- a/docs/models/components/outputtexteditorservertoolitem.mdx +++ b/docs/models/components/outputtexteditorservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:text_editor server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Command` | [*components.Command](../../models/components/command.mdx) | :heavy_minus_sign: | N/A | | -| `FilePath` | `*string` | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputTextEditorServerToolItemType](../../models/components/outputtexteditorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Command` | [*components.Command](../../models/components/command.mdx) | ➖ | N/A | | +| `FilePath` | `*string` | ➖ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputTextEditorServerToolItemType](../../models/components/outputtexteditorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputtokensdetails.mdx b/docs/models/components/outputtokensdetails.mdx index e4615eaa0..f5e57d954 100644 --- a/docs/models/components/outputtokensdetails.mdx +++ b/docs/models/components/outputtokensdetails.mdx @@ -6,4 +6,4 @@ title: "OutputTokensDetails" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ReasoningTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `ReasoningTokens` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputtoolsearchcallitem.mdx b/docs/models/components/outputtoolsearchcallitem.mdx index 8d32cfdbf..ebabd4695 100644 --- a/docs/models/components/outputtoolsearchcallitem.mdx +++ b/docs/models/components/outputtoolsearchcallitem.mdx @@ -9,9 +9,9 @@ A call the model made to a `tool_search` tool declared with `"execution": "clien | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Arguments` | `any` | :heavy_minus_sign: | N/A | | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `Execution` | [components.OutputToolSearchCallItemExecution](../../models/components/outputtoolsearchcallitemexecution.mdx) | :heavy_check_mark: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputToolSearchCallItemType](../../models/components/outputtoolsearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | `any` | ➖ | N/A | | +| `CallID` | `string` | ✅ | N/A | | +| `Execution` | [components.OutputToolSearchCallItemExecution](../../models/components/outputtoolsearchcallitemexecution.mdx) | ✅ | N/A | | +| `ID` | `*string` | ➖ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputToolSearchCallItemType](../../models/components/outputtoolsearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputtoolsearchservertoolitem.mdx b/docs/models/components/outputtoolsearchservertoolitem.mdx index c666221ff..6d32b0022 100644 --- a/docs/models/components/outputtoolsearchservertoolitem.mdx +++ b/docs/models/components/outputtoolsearchservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:tool_search server tool output item | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Query` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputToolSearchServerToolItemType](../../models/components/outputtoolsearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | ➖ | N/A | | +| `Query` | `*string` | ➖ | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputToolSearchServerToolItemType](../../models/components/outputtoolsearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebfetchservertoolitem.mdx b/docs/models/components/outputwebfetchservertoolitem.mdx index 181609b0f..fe48ddb91 100644 --- a/docs/models/components/outputwebfetchservertoolitem.mdx +++ b/docs/models/components/outputwebfetchservertoolitem.mdx @@ -9,11 +9,11 @@ An openrouter:web_fetch server tool output item | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Content` | `*string` | :heavy_minus_sign: | N/A | | -| `Error` | `*string` | :heavy_minus_sign: | The error message if the fetch failed. | | -| `HTTPStatus` | `*int64` | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Title` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputWebFetchServerToolItemType](../../models/components/outputwebfetchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | -| `URL` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Content` | `*string` | ➖ | N/A | | +| `Error` | `*string` | ➖ | The error message if the fetch failed. | | +| `HTTPStatus` | `*int64` | ➖ | The HTTP status code returned by the upstream URL fetch. | | +| `ID` | `*string` | ➖ | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | ✅ | N/A | completed | +| `Title` | `*string` | ➖ | N/A | | +| `Type` | [components.OutputWebFetchServerToolItemType](../../models/components/outputwebfetchservertoolitemtype.mdx) | ✅ | N/A | | +| `URL` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitem.mdx b/docs/models/components/outputwebsearchcallitem.mdx index 45f40bec8..3ea3d4d75 100644 --- a/docs/models/components/outputwebsearchcallitem.mdx +++ b/docs/models/components/outputwebsearchcallitem.mdx @@ -6,8 +6,8 @@ title: "OutputWebSearchCallItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputWebSearchCallItemActionUnion](../../models/components/outputwebsearchcallitemactionunion.mdx) | :heavy_minus_sign: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputWebSearchCallItemTypeWebSearchCall](../../models/components/outputwebsearchcallitemtypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file +| `Action` | [*components.OutputWebSearchCallItemActionUnion](../../models/components/outputwebsearchcallitemactionunion.mdx) | ➖ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputWebSearchCallItemTypeWebSearchCall](../../models/components/outputwebsearchcallitemtypewebsearchcall.mdx) | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitemactionfindinpage.mdx b/docs/models/components/outputwebsearchcallitemactionfindinpage.mdx index d847dda95..bcce8f459 100644 --- a/docs/models/components/outputwebsearchcallitemactionfindinpage.mdx +++ b/docs/models/components/outputwebsearchcallitemactionfindinpage.mdx @@ -6,6 +6,6 @@ title: "OutputWebSearchCallItemActionFindInPage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Pattern` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OutputWebSearchCallItemTypeFindInPage](../../models/components/outputwebsearchcallitemtypefindinpage.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Pattern` | `string` | ✅ | N/A | +| `Type` | [components.OutputWebSearchCallItemTypeFindInPage](../../models/components/outputwebsearchcallitemtypefindinpage.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitemactionopenpage.mdx b/docs/models/components/outputwebsearchcallitemactionopenpage.mdx index b2df0abc8..498b51277 100644 --- a/docs/models/components/outputwebsearchcallitemactionopenpage.mdx +++ b/docs/models/components/outputwebsearchcallitemactionopenpage.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchCallItemActionOpenPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OutputWebSearchCallItemTypeOpenPage](../../models/components/outputwebsearchcallitemtypeopenpage.mdx) | :heavy_check_mark: | N/A | -| `URL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | [components.OutputWebSearchCallItemTypeOpenPage](../../models/components/outputwebsearchcallitemtypeopenpage.mdx) | ✅ | N/A | +| `URL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitemactionsearch.mdx b/docs/models/components/outputwebsearchcallitemactionsearch.mdx index d0edcd035..fbe298d4f 100644 --- a/docs/models/components/outputwebsearchcallitemactionsearch.mdx +++ b/docs/models/components/outputwebsearchcallitemactionsearch.mdx @@ -6,7 +6,7 @@ title: "OutputWebSearchCallItemActionSearch" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Queries` | []`string` | :heavy_minus_sign: | N/A | -| `Query` | `string` | :heavy_check_mark: | N/A | -| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputWebSearchCallItemTypeSearch](../../models/components/outputwebsearchcallitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Queries` | []`string` | ➖ | N/A | +| `Query` | `string` | ✅ | N/A | +| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | ➖ | N/A | +| `Type` | [components.OutputWebSearchCallItemTypeSearch](../../models/components/outputwebsearchcallitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitem.mdx b/docs/models/components/outputwebsearchservertoolitem.mdx index 7b95e9e45..06429a4bd 100644 --- a/docs/models/components/outputwebsearchservertoolitem.mdx +++ b/docs/models/components/outputwebsearchservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:web_search server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Action` | [*components.OutputWebSearchServerToolItemAction](../../models/components/outputwebsearchservertoolitemaction.mdx) | :heavy_minus_sign: | The search action performed, matching OpenAI web_search_call.action shape. Includes the query the model issued and optional source URLs returned by the search provider. | | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../../models/components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Action` | [*components.OutputWebSearchServerToolItemAction](../../models/components/outputwebsearchservertoolitemaction.mdx) | ➖ | The search action performed, matching OpenAI web_search_call.action shape. Includes the query the model issued and optional source URLs returned by the search provider. | | +| `Error` | `*string` | ➖ | The error message when the tool call failed before producing a result. Set together with `status: 'failed'`; absent on a successful call. | Tool execution failed | +| `ID` | `*string` | ➖ | N/A | | +| `Status` | [components.FailableToolCallStatus](../../models/components/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `Type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../../models/components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitemaction.mdx b/docs/models/components/outputwebsearchservertoolitemaction.mdx index f48fb201d..e76b2d6ed 100644 --- a/docs/models/components/outputwebsearchservertoolitemaction.mdx +++ b/docs/models/components/outputwebsearchservertoolitemaction.mdx @@ -9,6 +9,6 @@ The search action performed, matching OpenAI web_search_call.action shape. Inclu | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Query` | `string` | :heavy_check_mark: | N/A | -| `Sources` | [][components.OutputWebSearchServerToolItemSource](../../models/components/outputwebsearchservertoolitemsource.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputWebSearchServerToolItemTypeSearch](../../models/components/outputwebsearchservertoolitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Query` | `string` | ✅ | N/A | +| `Sources` | [][components.OutputWebSearchServerToolItemSource](../../models/components/outputwebsearchservertoolitemsource.mdx) | ➖ | N/A | +| `Type` | [components.OutputWebSearchServerToolItemTypeSearch](../../models/components/outputwebsearchservertoolitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitemsource.mdx b/docs/models/components/outputwebsearchservertoolitemsource.mdx index a674d64af..b8f6856f5 100644 --- a/docs/models/components/outputwebsearchservertoolitemsource.mdx +++ b/docs/models/components/outputwebsearchservertoolitemsource.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchServerToolItemSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.OutputWebSearchServerToolItemTypeURL](../../models/components/outputwebsearchservertoolitemtypeurl.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OutputWebSearchServerToolItemTypeURL](../../models/components/outputwebsearchservertoolitemtypeurl.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/paretorouterplugin.mdx b/docs/models/components/paretorouterplugin.mdx index c499f4b7b..ba2ebc22b 100644 --- a/docs/models/components/paretorouterplugin.mdx +++ b/docs/models/components/paretorouterplugin.mdx @@ -6,8 +6,8 @@ title: "ParetoRouterPlugin" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | -| `ID` | [components.ParetoRouterPluginID](../../models/components/paretorouterpluginid.mdx) | :heavy_check_mark: | N/A | | -| `MaxPrice` | `*float64` | :heavy_minus_sign: | Maximum input price in USD per million tokens. When set, quality-tier selection (min_coding_score) is bypassed: the router computes the Pareto frontier over the top coding models and routes to the best-scoring frontier model priced at or below this cap, falling back through cheaper frontier models, then non-frontier models. Enforced against the price source given by price_source. Returns 404 when no candidate satisfies the cap. | 5 | -| `MinCodingScore` | `*float64` | :heavy_minus_sign: | Minimum coding quality score between 0 and 1. Maps to internal quality tiers: >= 0.66 → high (top coding models), >= 0.33 → medium (strong modern flagships), < 0.33 → low (capable coders above the median). Omit to default to the highest tier (equivalent to >= 0.66). Not used when max_price is set (price-based selection takes over). | 0.8 | -| `PriceSource` | [*components.PriceSource](../../models/components/pricesource.mdx) | :heavy_minus_sign: | Price source for the Pareto frontier cost axis and for enforcing max_price. "prompt" uses catalog list price (endpoint.pricing.prompt). "weighted_avg" uses traffic-weighted effective input price from ClickHouse, falling back to prompt price for models without traffic data. Defaults to "prompt". | | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | +| `ID` | [components.ParetoRouterPluginID](../../models/components/paretorouterpluginid.mdx) | ✅ | N/A | | +| `MaxPrice` | `*float64` | ➖ | Maximum input price in USD per million tokens. When set, quality-tier selection (min_coding_score) is bypassed: the router computes the Pareto frontier over the top coding models and routes to the best-scoring frontier model priced at or below this cap, falling back through cheaper frontier models, then non-frontier models. Enforced against the price source given by price_source. Returns 404 when no candidate satisfies the cap. | 5 | +| `MinCodingScore` | `*float64` | ➖ | Minimum coding quality score between 0 and 1. Maps to internal quality tiers: >= 0.66 → high (top coding models), >= 0.33 → medium (strong modern flagships), < 0.33 → low (capable coders above the median). Omit to default to the highest tier (equivalent to >= 0.66). Not used when max_price is set (price-based selection takes over). | 0.8 | +| `PriceSource` | [*components.PriceSource](../../models/components/pricesource.mdx) | ➖ | Price source for the Pareto frontier cost axis and for enforcing max_price. "prompt" uses catalog list price (endpoint.pricing.prompt). "weighted_avg" uses traffic-weighted effective input price from ClickHouse, falling back to prompt price for models without traffic data. Defaults to "prompt". | | \ No newline at end of file diff --git a/docs/models/components/partialcoverage.mdx b/docs/models/components/partialcoverage.mdx index 2a5e8dd1e..695c78498 100644 --- a/docs/models/components/partialcoverage.mdx +++ b/docs/models/components/partialcoverage.mdx @@ -6,5 +6,5 @@ title: "PartialCoverage" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Models` | []`string` | :heavy_check_mark: | N/A | -| `Point` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Models` | []`string` | ✅ | N/A | +| `Point` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/payloadtoolargeresponseerrordata.mdx b/docs/models/components/payloadtoolargeresponseerrordata.mdx index fabd4a759..423377083 100644 --- a/docs/models/components/payloadtoolargeresponseerrordata.mdx +++ b/docs/models/components/payloadtoolargeresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for PayloadTooLargeResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/paymentrequiredresponseerrordata.mdx b/docs/models/components/paymentrequiredresponseerrordata.mdx index a33c49cc2..67068fcca 100644 --- a/docs/models/components/paymentrequiredresponseerrordata.mdx +++ b/docs/models/components/paymentrequiredresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for PaymentRequiredResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/pdfparseroptions.mdx b/docs/models/components/pdfparseroptions.mdx index 7065b065a..9ee8419fd 100644 --- a/docs/models/components/pdfparseroptions.mdx +++ b/docs/models/components/pdfparseroptions.mdx @@ -9,4 +9,4 @@ Options for PDF parsing. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.PDFParserEngine](../../models/components/pdfparserengine.mdx) | :heavy_minus_sign: | The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". | cloudflare-ai | \ No newline at end of file +| `Engine` | [*components.PDFParserEngine](../../models/components/pdfparserengine.mdx) | ➖ | The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". | cloudflare-ai | \ No newline at end of file diff --git a/docs/models/components/pendingsafetycheck.mdx b/docs/models/components/pendingsafetycheck.mdx index 6a4fd63bd..ab6afff22 100644 --- a/docs/models/components/pendingsafetycheck.mdx +++ b/docs/models/components/pendingsafetycheck.mdx @@ -6,6 +6,6 @@ title: "PendingSafetyCheck" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Code` | `string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/percentilelatencycutoffs.mdx b/docs/models/components/percentilelatencycutoffs.mdx index 7cc5dae79..fd0e6ba5e 100644 --- a/docs/models/components/percentilelatencycutoffs.mdx +++ b/docs/models/components/percentilelatencycutoffs.mdx @@ -9,7 +9,7 @@ Percentile-based latency cutoffs. All specified cutoffs must be met for an endpo | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `P50` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p50 latency (seconds) | -| `P75` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p75 latency (seconds) | -| `P90` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p90 latency (seconds) | -| `P99` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file +| `P50` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum p50 latency (seconds) | +| `P75` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum p75 latency (seconds) | +| `P90` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum p90 latency (seconds) | +| `P99` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/docs/models/components/percentilestats.mdx b/docs/models/components/percentilestats.mdx index 6aabafaa0..56f6fdf53 100644 --- a/docs/models/components/percentilestats.mdx +++ b/docs/models/components/percentilestats.mdx @@ -9,7 +9,7 @@ Latency percentiles in milliseconds over the last 30 minutes. Latency measures t | Field | Type | Required | Description | Example | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `P50` | `float64` | :heavy_check_mark: | Median (50th percentile) | 25.5 | -| `P75` | `float64` | :heavy_check_mark: | 75th percentile | 35.2 | -| `P90` | `float64` | :heavy_check_mark: | 90th percentile | 48.7 | -| `P99` | `float64` | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file +| `P50` | `float64` | ✅ | Median (50th percentile) | 25.5 | +| `P75` | `float64` | ✅ | 75th percentile | 35.2 | +| `P90` | `float64` | ✅ | 90th percentile | 48.7 | +| `P99` | `float64` | ✅ | 99th percentile | 85.3 | \ No newline at end of file diff --git a/docs/models/components/percentilethroughputcutoffs.mdx b/docs/models/components/percentilethroughputcutoffs.mdx index b149d4fa3..7a536ff3c 100644 --- a/docs/models/components/percentilethroughputcutoffs.mdx +++ b/docs/models/components/percentilethroughputcutoffs.mdx @@ -9,7 +9,7 @@ Percentile-based throughput cutoffs. All specified cutoffs must be met for an en | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `P50` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | -| `P75` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | -| `P90` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | -| `P99` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file +| `P50` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum p50 throughput (tokens/sec) | +| `P75` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum p75 throughput (tokens/sec) | +| `P90` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum p90 throughput (tokens/sec) | +| `P99` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/docs/models/components/perflast30mbyworkload.mdx b/docs/models/components/perflast30mbyworkload.mdx index dde50725f..318aa1803 100644 --- a/docs/models/components/perflast30mbyworkload.mdx +++ b/docs/models/components/perflast30mbyworkload.mdx @@ -9,12 +9,12 @@ Endpoint performance over the last 30 minutes, keyed by the kind of request serv | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Decisions` | [*components.Decisions](../../models/components/decisions.mdx) | :heavy_minus_sign: | N/A | -| `Embeddings` | [*components.Embeddings](../../models/components/embeddings.mdx) | :heavy_minus_sign: | N/A | -| `ImageGeneration` | [*components.ImageGeneration](../../models/components/imagegeneration.mdx) | :heavy_minus_sign: | N/A | -| `Rerank` | [*components.Rerank](../../models/components/rerank.mdx) | :heavy_minus_sign: | N/A | -| `STT` | [*components.STT](../../models/components/stt.mdx) | :heavy_minus_sign: | N/A | -| `TextGeneration` | [*components.TextGeneration](../../models/components/textgeneration.mdx) | :heavy_minus_sign: | N/A | -| `TTS` | [*components.TTS](../../models/components/tts.mdx) | :heavy_minus_sign: | N/A | -| `Unknown` | [*components.Unknown](../../models/components/unknown.mdx) | :heavy_minus_sign: | N/A | -| `VideoGeneration` | [*components.VideoGeneration](../../models/components/videogeneration.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Decisions` | [*components.Decisions](../../models/components/decisions.mdx) | ➖ | N/A | +| `Embeddings` | [*components.Embeddings](../../models/components/embeddings.mdx) | ➖ | N/A | +| `ImageGeneration` | [*components.ImageGeneration](../../models/components/imagegeneration.mdx) | ➖ | N/A | +| `Rerank` | [*components.Rerank](../../models/components/rerank.mdx) | ➖ | N/A | +| `STT` | [*components.STT](../../models/components/stt.mdx) | ➖ | N/A | +| `TextGeneration` | [*components.TextGeneration](../../models/components/textgeneration.mdx) | ➖ | N/A | +| `TTS` | [*components.TTS](../../models/components/tts.mdx) | ➖ | N/A | +| `Unknown` | [*components.Unknown](../../models/components/unknown.mdx) | ➖ | N/A | +| `VideoGeneration` | [*components.VideoGeneration](../../models/components/videogeneration.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/perrequestlimits.mdx b/docs/models/components/perrequestlimits.mdx index 57dfcd45c..b18992532 100644 --- a/docs/models/components/perrequestlimits.mdx +++ b/docs/models/components/perrequestlimits.mdx @@ -9,5 +9,5 @@ Per-request token limits | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `CompletionTokens` | `float64` | :heavy_check_mark: | Maximum completion tokens per request | 1000 | -| `PromptTokens` | `float64` | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | \ No newline at end of file +| `CompletionTokens` | `float64` | ✅ | Maximum completion tokens per request | 1000 | +| `PromptTokens` | `float64` | ✅ | Maximum prompt tokens per request | 1000 | \ No newline at end of file diff --git a/docs/models/components/pipelinestage.mdx b/docs/models/components/pipelinestage.mdx index ced1b8f85..03a8a387f 100644 --- a/docs/models/components/pipelinestage.mdx +++ b/docs/models/components/pipelinestage.mdx @@ -6,10 +6,10 @@ title: "PipelineStage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CostUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `Data` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `GuardrailID` | `*string` | :heavy_minus_sign: | N/A | | -| `GuardrailScope` | `*string` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Summary` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.PipelineStageType](../../models/components/pipelinestagetype.mdx) | :heavy_check_mark: | Categorical kind of a pipeline stage. Multiple plugins can share a type (e.g. all guardrail-level plugins emit `guardrail`); the `name` field disambiguates which plugin emitted it. | guardrail | \ No newline at end of file +| `CostUsd` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | +| `Data` | map[string]`any` | ➖ | N/A | | +| `GuardrailID` | `*string` | ➖ | N/A | | +| `GuardrailScope` | `*string` | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Summary` | `*string` | ➖ | N/A | | +| `Type` | [components.PipelineStageType](../../models/components/pipelinestagetype.mdx) | ✅ | Categorical kind of a pipeline stage. Multiple plugins can share a type (e.g. all guardrail-level plugins emit `guardrail`); the `name` field disambiguates which plugin emitted it. | guardrail | \ No newline at end of file diff --git a/docs/models/components/prediction.mdx b/docs/models/components/prediction.mdx index 5cbb82074..10d6d26ae 100644 --- a/docs/models/components/prediction.mdx +++ b/docs/models/components/prediction.mdx @@ -9,5 +9,5 @@ Static predicted output content. Supported models can use this to reduce latency | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Content` | [components.PredictionContent](../../models/components/predictioncontent.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.PredictionType](../../models/components/predictiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [components.PredictionContent](../../models/components/predictioncontent.mdx) | ✅ | N/A | +| `Type` | [components.PredictionType](../../models/components/predictiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/predictioncontenttext.mdx b/docs/models/components/predictioncontenttext.mdx index d28120b65..6242b5429 100644 --- a/docs/models/components/predictioncontenttext.mdx +++ b/docs/models/components/predictioncontenttext.mdx @@ -9,5 +9,5 @@ Text content part for a predicted output. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.PredictionContentTextType](../../models/components/predictioncontenttexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.PredictionContentTextType](../../models/components/predictioncontenttexttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/preset.mdx b/docs/models/components/preset.mdx index 33eec201c..c3cf8e279 100644 --- a/docs/models/components/preset.mdx +++ b/docs/models/components/preset.mdx @@ -9,14 +9,14 @@ A preset without version details. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | | -| `CreatorUserID` | `*string` | :heavy_check_mark: | N/A | | -| `Description` | `*string` | :heavy_check_mark: | N/A | | -| `DesignatedVersionID` | `*string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Slug` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | -| `StatusUpdatedAt` | `*string` | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | | -| `WorkspaceID` | `*string` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | N/A | | +| `CreatorUserID` | `*string` | ✅ | N/A | | +| `Description` | `*string` | ✅ | N/A | | +| `DesignatedVersionID` | `*string` | ✅ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Slug` | `string` | ✅ | N/A | | +| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | ✅ | The status of a preset. | active | +| `StatusUpdatedAt` | `*string` | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | N/A | | +| `WorkspaceID` | `*string` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/presetdesignatedversion.mdx b/docs/models/components/presetdesignatedversion.mdx index 94a959054..7eaefd95f 100644 --- a/docs/models/components/presetdesignatedversion.mdx +++ b/docs/models/components/presetdesignatedversion.mdx @@ -9,11 +9,11 @@ A specific version of a preset, containing config and optional system prompt. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Config` | map[string]`any` | :heavy_check_mark: | N/A | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | -| `CreatorID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `PresetID` | `string` | :heavy_check_mark: | N/A | -| `SystemPrompt` | `*string` | :heavy_check_mark: | N/A | -| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | -| `Version` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Config` | map[string]`any` | ✅ | N/A | +| `CreatedAt` | `string` | ✅ | N/A | +| `CreatorID` | `string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `PresetID` | `string` | ✅ | N/A | +| `SystemPrompt` | `*string` | ✅ | N/A | +| `UpdatedAt` | `string` | ✅ | N/A | +| `Version` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/presetwithdesignatedversion.mdx b/docs/models/components/presetwithdesignatedversion.mdx index bec3d33fb..cd2639fbe 100644 --- a/docs/models/components/presetwithdesignatedversion.mdx +++ b/docs/models/components/presetwithdesignatedversion.mdx @@ -9,15 +9,15 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | | -| `CreatorUserID` | `*string` | :heavy_check_mark: | N/A | | -| `Description` | `*string` | :heavy_check_mark: | N/A | | -| `DesignatedVersionID` | `*string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Slug` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | -| `StatusUpdatedAt` | `*string` | :heavy_check_mark: | N/A | | -| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | | -| `WorkspaceID` | `*string` | :heavy_check_mark: | N/A | | -| `DesignatedVersion` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | :heavy_check_mark: | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | N/A | | +| `CreatorUserID` | `*string` | ✅ | N/A | | +| `Description` | `*string` | ✅ | N/A | | +| `DesignatedVersionID` | `*string` | ✅ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Slug` | `string` | ✅ | N/A | | +| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | ✅ | The status of a preset. | active | +| `StatusUpdatedAt` | `*string` | ✅ | N/A | | +| `UpdatedAt` | `string` | ✅ | N/A | | +| `WorkspaceID` | `*string` | ✅ | N/A | | +| `DesignatedVersion` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | ✅ | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file diff --git a/docs/models/components/preview20250311websearchservertool.mdx b/docs/models/components/preview20250311websearchservertool.mdx index 9b7a4bf9b..dc1656307 100644 --- a/docs/models/components/preview20250311websearchservertool.mdx +++ b/docs/models/components/preview20250311websearchservertool.mdx @@ -9,12 +9,12 @@ Web search preview tool configuration (2025-03-11 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.Preview20250311WebSearchServerToolType](../../models/components/preview20250311websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `Type` | [components.Preview20250311WebSearchServerToolType](../../models/components/preview20250311websearchservertooltype.mdx) | ✅ | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/previewwebsearchservertool.mdx b/docs/models/components/previewwebsearchservertool.mdx index b0b325a88..913c2d519 100644 --- a/docs/models/components/previewwebsearchservertool.mdx +++ b/docs/models/components/previewwebsearchservertool.mdx @@ -9,12 +9,12 @@ Web search preview tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.PreviewWebSearchServerToolType](../../models/components/previewwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `Type` | [components.PreviewWebSearchServerToolType](../../models/components/previewwebsearchservertooltype.mdx) | ✅ | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/previewwebsearchuserlocation.mdx b/docs/models/components/previewwebsearchuserlocation.mdx index e0ffc5a49..8c41c3cb7 100644 --- a/docs/models/components/previewwebsearchuserlocation.mdx +++ b/docs/models/components/previewwebsearchuserlocation.mdx @@ -6,8 +6,8 @@ title: "PreviewWebSearchUserLocation" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.PreviewWebSearchUserLocationType](../../models/components/previewwebsearchuserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.PreviewWebSearchUserLocationType](../../models/components/previewwebsearchuserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/pricing.mdx b/docs/models/components/pricing.mdx index 9f14372a8..4d14c44f7 100644 --- a/docs/models/components/pricing.mdx +++ b/docs/models/components/pricing.mdx @@ -6,19 +6,19 @@ title: "Pricing" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Audio` | `*string` | :heavy_minus_sign: | Price in USD per audio input token | -| `AudioOutput` | `*string` | :heavy_minus_sign: | Price in USD per audio output token | -| `Completion` | `string` | :heavy_check_mark: | Price in USD per token for completion (output) generation | -| `Discount` | `*float64` | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `Image` | `*string` | :heavy_minus_sign: | Price in USD per input image | -| `ImageOutput` | `*string` | :heavy_minus_sign: | Price in USD per output image | -| `ImageToken` | `*string` | :heavy_minus_sign: | Price in USD per image token | -| `InputAudioCache` | `*string` | :heavy_minus_sign: | Price in USD per cached audio input token | -| `InputCacheRead` | `*string` | :heavy_minus_sign: | Price in USD per cached input token (read) | -| `InputCacheWrite` | `*string` | :heavy_minus_sign: | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | -| `InputCacheWrite1h` | `*string` | :heavy_minus_sign: | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | -| `InternalReasoning` | `*string` | :heavy_minus_sign: | Price in USD per internal reasoning token | -| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride.mdx) | :heavy_minus_sign: | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | -| `Prompt` | `string` | :heavy_check_mark: | Price in USD per token for prompt (input) processing | -| `Request` | `*string` | :heavy_minus_sign: | Price in USD per request | -| `WebSearch` | `*string` | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file +| `Audio` | `*string` | ➖ | Price in USD per audio input token | +| `AudioOutput` | `*string` | ➖ | Price in USD per audio output token | +| `Completion` | `string` | ✅ | Price in USD per token for completion (output) generation | +| `Discount` | `*float64` | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `Image` | `*string` | ➖ | Price in USD per input image | +| `ImageOutput` | `*string` | ➖ | Price in USD per output image | +| `ImageToken` | `*string` | ➖ | Price in USD per image token | +| `InputAudioCache` | `*string` | ➖ | Price in USD per cached audio input token | +| `InputCacheRead` | `*string` | ➖ | Price in USD per cached input token (read) | +| `InputCacheWrite` | `*string` | ➖ | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | +| `InputCacheWrite1h` | `*string` | ➖ | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | +| `InternalReasoning` | `*string` | ➖ | Price in USD per internal reasoning token | +| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride.mdx) | ➖ | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | +| `Prompt` | `string` | ✅ | Price in USD per token for prompt (input) processing | +| `Request` | `*string` | ➖ | Price in USD per request | +| `WebSearch` | `*string` | ➖ | Price in USD per web search | \ No newline at end of file diff --git a/docs/models/components/pricingoverride.mdx b/docs/models/components/pricingoverride.mdx index 081646d35..41af63402 100644 --- a/docs/models/components/pricingoverride.mdx +++ b/docs/models/components/pricingoverride.mdx @@ -9,14 +9,14 @@ A conditional override of the base pricing. An entry applies only when all of it | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Audio` | `*string` | :heavy_minus_sign: | Overridden price in USD per audio input token | -| `Completion` | `*string` | :heavy_minus_sign: | Overridden price in USD per token for completion (output) generation | -| `InputAudioCache` | `*string` | :heavy_minus_sign: | Overridden price in USD per cached audio input token | -| `InputCacheRead` | `*string` | :heavy_minus_sign: | Overridden price in USD per cached input token (read) | -| `InputCacheWrite` | `*string` | :heavy_minus_sign: | Overridden price in USD per cache-write token | -| `InputCacheWrite1h` | `*string` | :heavy_minus_sign: | Overridden price in USD per 1-hour cache-write token | -| `MinPromptTokens` | `*float64` | :heavy_minus_sign: | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | -| `Prompt` | `*string` | :heavy_minus_sign: | Overridden price in USD per token for prompt (input) processing | -| `UtcDays` | [][components.UtcDay](../../models/components/utcday.mdx) | :heavy_minus_sign: | Condition: UTC weekdays the entry applies on, evaluated at the request instant. Scopes the utc_start/utc_end window (or, without a window, the whole UTC day) to the listed days. Absent means every day. | -| `UtcEnd` | `*float64` | :heavy_minus_sign: | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | -| `UtcStart` | `*float64` | :heavy_minus_sign: | Condition: inclusive start of a daily UTC time window as an HHMM clock number (e.g. 100 = 01:00, 1030 = 10:30). The entry applies while the current UTC time is inside the half-open window [utc_start, utc_end), which may wrap past midnight (utc_start > utc_end). | \ No newline at end of file +| `Audio` | `*string` | ➖ | Overridden price in USD per audio input token | +| `Completion` | `*string` | ➖ | Overridden price in USD per token for completion (output) generation | +| `InputAudioCache` | `*string` | ➖ | Overridden price in USD per cached audio input token | +| `InputCacheRead` | `*string` | ➖ | Overridden price in USD per cached input token (read) | +| `InputCacheWrite` | `*string` | ➖ | Overridden price in USD per cache-write token | +| `InputCacheWrite1h` | `*string` | ➖ | Overridden price in USD per 1-hour cache-write token | +| `MinPromptTokens` | `*float64` | ➖ | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | +| `Prompt` | `*string` | ➖ | Overridden price in USD per token for prompt (input) processing | +| `UtcDays` | [][components.UtcDay](../../models/components/utcday.mdx) | ➖ | Condition: UTC weekdays the entry applies on, evaluated at the request instant. Scopes the utc_start/utc_end window (or, without a window, the whole UTC day) to the listed days. Absent means every day. | +| `UtcEnd` | `*float64` | ➖ | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | +| `UtcStart` | `*float64` | ➖ | Condition: inclusive start of a daily UTC time window as an HHMM clock number (e.g. 100 = 01:00, 1030 = 10:30). The entry applies while the current UTC time is inside the half-open window [utc_start, utc_end), which may wrap past midnight (utc_start > utc_end). | \ No newline at end of file diff --git a/docs/models/components/privateendpoint.mdx b/docs/models/components/privateendpoint.mdx index 2c5d84e65..f136d9441 100644 --- a/docs/models/components/privateendpoint.mdx +++ b/docs/models/components/privateendpoint.mdx @@ -6,15 +6,15 @@ title: "PrivateEndpoint" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BaseURL` | `*string` | :heavy_check_mark: | HTTPS base URL of your deployment, or `null` for providers whose URL is derived from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `DeclaredRegion` | [*components.PrivateEndpointDeclaredRegion](../../models/components/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `DeclaredZdr` | `*bool` | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `ModelName` | `*string` | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `ModelSlug` | `*string` | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `Pricing` | [components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `ProviderName` | `string` | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `ProviderSlug` | `*string` | :heavy_check_mark: | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | -| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | -| `UpstreamModelID` | `string` | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `BaseURL` | `*string` | ✅ | HTTPS base URL of your deployment, or `null` for providers whose URL is derived from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `DeclaredRegion` | [*components.PrivateEndpointDeclaredRegion](../../models/components/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `DeclaredZdr` | `*bool` | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `ModelName` | `*string` | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `ModelPermaslug` | `string` | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `ModelSlug` | `*string` | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `Pricing` | [components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `ProviderName` | `string` | ✅ | Display name of the upstream provider. | Azure | +| `ProviderSlug` | `*string` | ✅ | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | +| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | +| `UpstreamModelID` | `string` | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/components/privateendpointactivation.mdx b/docs/models/components/privateendpointactivation.mdx index 49915baf3..7f4328a43 100644 --- a/docs/models/components/privateendpointactivation.mdx +++ b/docs/models/components/privateendpointactivation.mdx @@ -9,4 +9,4 @@ Validate and activate in the same call. On a failed validation the draft is kept | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `WorkspaceID` | `string` | :heavy_check_mark: | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `WorkspaceID` | `string` | ✅ | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/privateendpointcheck.mdx b/docs/models/components/privateendpointcheck.mdx index d7cf98a6e..81d19f15a 100644 --- a/docs/models/components/privateendpointcheck.mdx +++ b/docs/models/components/privateendpointcheck.mdx @@ -6,9 +6,9 @@ title: "PrivateEndpointCheck" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `ActualModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Model the upstream reported serving, when it differs from the request. | | -| `Name` | `string` | :heavy_check_mark: | Check name. | auth_ok | -| `Passed` | `bool` | :heavy_check_mark: | N/A | | -| `Reason` | [*components.PrivateEndpointCheckReason](../../models/components/privateendpointcheckreason.mdx) | :heavy_minus_sign: | Why the check failed. | no_byok_key | -| `UpstreamMessage` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Error message returned by your deployment when the call failed. | | -| `UpstreamStatus` | `*int64` | :heavy_minus_sign: | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file +| `ActualModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Model the upstream reported serving, when it differs from the request. | | +| `Name` | `string` | ✅ | Check name. | auth_ok | +| `Passed` | `bool` | ✅ | N/A | | +| `Reason` | [*components.PrivateEndpointCheckReason](../../models/components/privateendpointcheckreason.mdx) | ➖ | Why the check failed. | no_byok_key | +| `UpstreamMessage` | optionalnullable.OptionalNullable[`string`] | ➖ | Error message returned by your deployment when the call failed. | | +| `UpstreamStatus` | `*int64` | ➖ | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file diff --git a/docs/models/components/privateendpointpricing.mdx b/docs/models/components/privateendpointpricing.mdx index e998f5335..560e0c9aa 100644 --- a/docs/models/components/privateendpointpricing.mdx +++ b/docs/models/components/privateendpointpricing.mdx @@ -9,5 +9,5 @@ Negotiated per-token rates reported for requests routed to this endpoint. | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `Completion` | `string` | :heavy_check_mark: | USD per completion token, as a decimal string. | 0.00001 | -| `Prompt` | `string` | :heavy_check_mark: | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file +| `Completion` | `string` | ✅ | USD per completion token, as a decimal string. | 0.00001 | +| `Prompt` | `string` | ✅ | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file diff --git a/docs/models/components/privateendpointresponse.mdx b/docs/models/components/privateendpointresponse.mdx index 71ee6ad29..ed0568243 100644 --- a/docs/models/components/privateendpointresponse.mdx +++ b/docs/models/components/privateendpointresponse.mdx @@ -6,4 +6,4 @@ title: "PrivateEndpointResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PrivateEndpoint](../../models/components/privateendpoint.mdx) | :heavy_check_mark: | N/A | \{
"base_url": "https://contoso.openai.azure.com",
"declared_region": "us",
"declared_zdr": true,
"id": "5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11",
"model_name": "OpenAI: GPT-4o",
"model_permaslug": "openai/gpt-4o-2024-08-06",
"model_slug": "openai/gpt-4o",
"pricing": \{
"completion": "0.00001",
"prompt": "0.0000025"
},
"provider_name": "Azure",
"provider_slug": "azure",
"status": "active",
"upstream_model_id": "gpt-4o-prod"
} | \ No newline at end of file +| `Data` | [components.PrivateEndpoint](../../models/components/privateendpoint.mdx) | ✅ | N/A | \{
"base_url": "https://contoso.openai.azure.com",
"declared_region": "us",
"declared_zdr": true,
"id": "5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11",
"model_name": "OpenAI: GPT-4o",
"model_permaslug": "openai/gpt-4o-2024-08-06",
"model_slug": "openai/gpt-4o",
"pricing": \{
"completion": "0.00001",
"prompt": "0.0000025"
},
"provider_name": "Azure",
"provider_slug": "azure",
"status": "active",
"upstream_model_id": "gpt-4o-prod"
} | \ No newline at end of file diff --git a/docs/models/components/privateendpointsummary.mdx b/docs/models/components/privateendpointsummary.mdx index 9b2b9bc9a..026b6e31b 100644 --- a/docs/models/components/privateendpointsummary.mdx +++ b/docs/models/components/privateendpointsummary.mdx @@ -6,10 +6,10 @@ title: "PrivateEndpointSummary" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `ModelName` | `*string` | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `ModelSlug` | `*string` | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `ProviderName` | `string` | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `ModelName` | `*string` | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `ModelPermaslug` | `string` | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `ModelSlug` | `*string` | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `ProviderName` | `string` | ✅ | Display name of the upstream provider. | Azure | +| `Status` | [components.PrivateEndpointStatus](../../models/components/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | \ No newline at end of file diff --git a/docs/models/components/privateendpointvalidation.mdx b/docs/models/components/privateendpointvalidation.mdx index 275a5325d..31cd81f72 100644 --- a/docs/models/components/privateendpointvalidation.mdx +++ b/docs/models/components/privateendpointvalidation.mdx @@ -6,5 +6,5 @@ title: "PrivateEndpointValidation" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Checks` | [][components.PrivateEndpointCheck](../../models/components/privateendpointcheck.mdx) | :heavy_check_mark: | N/A | | -| `Passed` | `bool` | :heavy_check_mark: | Whether every check passed. | true | \ No newline at end of file +| `Checks` | [][components.PrivateEndpointCheck](../../models/components/privateendpointcheck.mdx) | ✅ | N/A | | +| `Passed` | `bool` | ✅ | Whether every check passed. | true | \ No newline at end of file diff --git a/docs/models/components/privateendpointvalidationnullable.mdx b/docs/models/components/privateendpointvalidationnullable.mdx index 2874980d4..2516ce73c 100644 --- a/docs/models/components/privateendpointvalidationnullable.mdx +++ b/docs/models/components/privateendpointvalidationnullable.mdx @@ -6,5 +6,5 @@ title: "PrivateEndpointValidationNullable" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Checks` | [][components.PrivateEndpointCheck](../../models/components/privateendpointcheck.mdx) | :heavy_check_mark: | N/A | | -| `Passed` | `bool` | :heavy_check_mark: | Whether every check passed. | true | \ No newline at end of file +| `Checks` | [][components.PrivateEndpointCheck](../../models/components/privateendpointcheck.mdx) | ✅ | N/A | | +| `Passed` | `bool` | ✅ | Whether every check passed. | true | \ No newline at end of file diff --git a/docs/models/components/privateendpointvalidationresponse.mdx b/docs/models/components/privateendpointvalidationresponse.mdx index 61b858d36..d070dffa2 100644 --- a/docs/models/components/privateendpointvalidationresponse.mdx +++ b/docs/models/components/privateendpointvalidationresponse.mdx @@ -6,4 +6,4 @@ title: "PrivateEndpointValidationResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Data` | [components.PrivateEndpointValidation](../../models/components/privateendpointvalidation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.PrivateEndpointValidation](../../models/components/privateendpointvalidation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/progress.mdx b/docs/models/components/progress.mdx index 9ca155e3d..4b01a7a38 100644 --- a/docs/models/components/progress.mdx +++ b/docs/models/components/progress.mdx @@ -9,6 +9,6 @@ Active provisioning step, or null once provisioning has settled. | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `StepLabel` | `string` | :heavy_check_mark: | Human-readable label of the active provisioning step. | -| `StepNumber` | `int64` | :heavy_check_mark: | One-based index of the active step. | -| `TotalSteps` | `int64` | :heavy_check_mark: | Number of provisioning steps. | \ No newline at end of file +| `StepLabel` | `string` | ✅ | Human-readable label of the active provisioning step. | +| `StepNumber` | `int64` | ✅ | One-based index of the active step. | +| `TotalSteps` | `int64` | ✅ | Number of provisioning steps. | \ No newline at end of file diff --git a/docs/models/components/promptcachebreakpoint.mdx b/docs/models/components/promptcachebreakpoint.mdx index 0c7f5e033..552b9ccca 100644 --- a/docs/models/components/promptcachebreakpoint.mdx +++ b/docs/models/components/promptcachebreakpoint.mdx @@ -9,4 +9,4 @@ Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Ev | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Mode` | [components.PromptCacheBreakpointMode](../../models/components/promptcachebreakpointmode.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Mode` | [components.PromptCacheBreakpointMode](../../models/components/promptcachebreakpointmode.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/promptcacheoptions.mdx b/docs/models/components/promptcacheoptions.mdx index 6a2316017..0cbb412be 100644 --- a/docs/models/components/promptcacheoptions.mdx +++ b/docs/models/components/promptcacheoptions.mdx @@ -9,5 +9,5 @@ Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Mode` | [components.PromptCacheOptionsMode](../../models/components/promptcacheoptionsmode.mdx) | :heavy_check_mark: | N/A | -| `TTL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Mode` | [components.PromptCacheOptionsMode](../../models/components/promptcacheoptionsmode.mdx) | ✅ | N/A | +| `TTL` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/provideroptions.mdx b/docs/models/components/provideroptions.mdx index b6fea2a1b..3dafb8d56 100644 --- a/docs/models/components/provideroptions.mdx +++ b/docs/models/components/provideroptions.mdx @@ -9,149 +9,149 @@ Provider-specific options keyed by provider slug. Only options for the matched p | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Oneai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ai21` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AionLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Akashml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Alibaba` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonBedrock` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonBedrockClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonNova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ambient` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anthropic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anthropic2` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anyscale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ArceeAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Assemblyai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AtlasCloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Atoma` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Avian` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Azure` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baidu` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baseten` | map[string]`any` | :heavy_minus_sign: | N/A | -| `BlackForestLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Byteplus` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Centml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cerebras` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Chutes` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cirrascale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Clarifai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cloudflare` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cohere` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Coreweave` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cosine` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crofai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crucible` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crusoe` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Darkbloom` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Databricks` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Decart` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepgram` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepinfra` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepseek` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Dekallm` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Digitalocean` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Elevenlabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Enfer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `FakeProvider` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Featherless` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Fireworks` | map[string]`any` | :heavy_minus_sign: | N/A | -| `FishAudio` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Friendli` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gmicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleAiStudio` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleVertex` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gopomelo` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Groq` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Heygen` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Huggingface` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Hyperbolic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `HyperbolicQuantized` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inception` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `InferactVllm` | map[string]`any` | :heavy_minus_sign: | N/A | -| `InferenceNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Infermatic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inocloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `IoNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ionstream` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Klusterai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Krea` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lambda` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lepton` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Liquid` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lynn` | map[string]`any` | :heavy_minus_sign: | N/A | -| `LynnPrivate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Makora` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mancer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `MancerOld` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mara` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Meta` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Minimax` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mistral` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modelrun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modular` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Moonshotai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Morph` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ncompass` | map[string]`any` | :heavy_minus_sign: | N/A | -| `NearAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nebius` | map[string]`any` | :heavy_minus_sign: | N/A | -| `NexAgi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nextbit` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nineteen` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Novita` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nvidia` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Octoai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ollama` | map[string]`any` | :heavy_minus_sign: | N/A | -| `OpenInference` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Openai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Parasail` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perplexity` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Phala` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Poolside` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Primeintellect` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Quiver` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recraft` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recursal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reka` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Relace` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Replicate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Respan` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Runway` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SailResearch` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sakana` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SakanaAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sambanova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SambanovaCloaked` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Scaledown` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Seed` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SfCompute` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Siliconflow` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sourceful` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stealth` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stepfun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Streamlake` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Switchpoint` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Targon` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Tencent` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Tenstorrent` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Thinkingmachines` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Together` | map[string]`any` | :heavy_minus_sign: | N/A | -| `TogetherLite` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Typesafe` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ubicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Unbiased` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Upstage` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Venice` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Voyageai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Wafer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Wandb` | map[string]`any` | :heavy_minus_sign: | N/A | -| `WandbLegacy` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xiaomi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ZAi` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Oneai` | map[string]`any` | ➖ | N/A | +| `Ai21` | map[string]`any` | ➖ | N/A | +| `AionLabs` | map[string]`any` | ➖ | N/A | +| `Akashml` | map[string]`any` | ➖ | N/A | +| `Alibaba` | map[string]`any` | ➖ | N/A | +| `AmazonBedrock` | map[string]`any` | ➖ | N/A | +| `AmazonBedrockClaudeOnAws` | map[string]`any` | ➖ | N/A | +| `AmazonNova` | map[string]`any` | ➖ | N/A | +| `Ambient` | map[string]`any` | ➖ | N/A | +| `Anthropic` | map[string]`any` | ➖ | N/A | +| `Anthropic2` | map[string]`any` | ➖ | N/A | +| `Anyscale` | map[string]`any` | ➖ | N/A | +| `ArceeAi` | map[string]`any` | ➖ | N/A | +| `Assemblyai` | map[string]`any` | ➖ | N/A | +| `AtlasCloud` | map[string]`any` | ➖ | N/A | +| `Atoma` | map[string]`any` | ➖ | N/A | +| `Avian` | map[string]`any` | ➖ | N/A | +| `Azure` | map[string]`any` | ➖ | N/A | +| `Baidu` | map[string]`any` | ➖ | N/A | +| `Baseten` | map[string]`any` | ➖ | N/A | +| `BlackForestLabs` | map[string]`any` | ➖ | N/A | +| `Byteplus` | map[string]`any` | ➖ | N/A | +| `Centml` | map[string]`any` | ➖ | N/A | +| `Cerebras` | map[string]`any` | ➖ | N/A | +| `Chutes` | map[string]`any` | ➖ | N/A | +| `Cirrascale` | map[string]`any` | ➖ | N/A | +| `Clarifai` | map[string]`any` | ➖ | N/A | +| `ClaudeOnAws` | map[string]`any` | ➖ | N/A | +| `Cloudflare` | map[string]`any` | ➖ | N/A | +| `Cohere` | map[string]`any` | ➖ | N/A | +| `Coreweave` | map[string]`any` | ➖ | N/A | +| `Cosine` | map[string]`any` | ➖ | N/A | +| `Crofai` | map[string]`any` | ➖ | N/A | +| `Crucible` | map[string]`any` | ➖ | N/A | +| `Crusoe` | map[string]`any` | ➖ | N/A | +| `Darkbloom` | map[string]`any` | ➖ | N/A | +| `Databricks` | map[string]`any` | ➖ | N/A | +| `Decart` | map[string]`any` | ➖ | N/A | +| `Deepgram` | map[string]`any` | ➖ | N/A | +| `Deepinfra` | map[string]`any` | ➖ | N/A | +| `Deepseek` | map[string]`any` | ➖ | N/A | +| `Dekallm` | map[string]`any` | ➖ | N/A | +| `Digitalocean` | map[string]`any` | ➖ | N/A | +| `Elevenlabs` | map[string]`any` | ➖ | N/A | +| `Enfer` | map[string]`any` | ➖ | N/A | +| `FakeProvider` | map[string]`any` | ➖ | N/A | +| `Featherless` | map[string]`any` | ➖ | N/A | +| `Fireworks` | map[string]`any` | ➖ | N/A | +| `FishAudio` | map[string]`any` | ➖ | N/A | +| `Friendli` | map[string]`any` | ➖ | N/A | +| `Gmicloud` | map[string]`any` | ➖ | N/A | +| `GoogleAiStudio` | map[string]`any` | ➖ | N/A | +| `GoogleVertex` | map[string]`any` | ➖ | N/A | +| `Gopomelo` | map[string]`any` | ➖ | N/A | +| `Groq` | map[string]`any` | ➖ | N/A | +| `Heygen` | map[string]`any` | ➖ | N/A | +| `Huggingface` | map[string]`any` | ➖ | N/A | +| `Hyperbolic` | map[string]`any` | ➖ | N/A | +| `HyperbolicQuantized` | map[string]`any` | ➖ | N/A | +| `Inception` | map[string]`any` | ➖ | N/A | +| `Inceptron` | map[string]`any` | ➖ | N/A | +| `InferactVllm` | map[string]`any` | ➖ | N/A | +| `InferenceNet` | map[string]`any` | ➖ | N/A | +| `Infermatic` | map[string]`any` | ➖ | N/A | +| `Inflection` | map[string]`any` | ➖ | N/A | +| `Inocloud` | map[string]`any` | ➖ | N/A | +| `IoNet` | map[string]`any` | ➖ | N/A | +| `Ionstream` | map[string]`any` | ➖ | N/A | +| `Klusterai` | map[string]`any` | ➖ | N/A | +| `Krea` | map[string]`any` | ➖ | N/A | +| `Lambda` | map[string]`any` | ➖ | N/A | +| `Lepton` | map[string]`any` | ➖ | N/A | +| `Liquid` | map[string]`any` | ➖ | N/A | +| `Lynn` | map[string]`any` | ➖ | N/A | +| `LynnPrivate` | map[string]`any` | ➖ | N/A | +| `Makora` | map[string]`any` | ➖ | N/A | +| `Mancer` | map[string]`any` | ➖ | N/A | +| `MancerOld` | map[string]`any` | ➖ | N/A | +| `Mara` | map[string]`any` | ➖ | N/A | +| `Meta` | map[string]`any` | ➖ | N/A | +| `Minimax` | map[string]`any` | ➖ | N/A | +| `Mistral` | map[string]`any` | ➖ | N/A | +| `Modal` | map[string]`any` | ➖ | N/A | +| `Modelrun` | map[string]`any` | ➖ | N/A | +| `Modular` | map[string]`any` | ➖ | N/A | +| `Moonshotai` | map[string]`any` | ➖ | N/A | +| `Morph` | map[string]`any` | ➖ | N/A | +| `Ncompass` | map[string]`any` | ➖ | N/A | +| `NearAi` | map[string]`any` | ➖ | N/A | +| `Nebius` | map[string]`any` | ➖ | N/A | +| `NexAgi` | map[string]`any` | ➖ | N/A | +| `Nextbit` | map[string]`any` | ➖ | N/A | +| `Nineteen` | map[string]`any` | ➖ | N/A | +| `Novita` | map[string]`any` | ➖ | N/A | +| `Nvidia` | map[string]`any` | ➖ | N/A | +| `Octoai` | map[string]`any` | ➖ | N/A | +| `Ollama` | map[string]`any` | ➖ | N/A | +| `OpenInference` | map[string]`any` | ➖ | N/A | +| `Openai` | map[string]`any` | ➖ | N/A | +| `Parasail` | map[string]`any` | ➖ | N/A | +| `Perceptron` | map[string]`any` | ➖ | N/A | +| `Perplexity` | map[string]`any` | ➖ | N/A | +| `Phala` | map[string]`any` | ➖ | N/A | +| `Poolside` | map[string]`any` | ➖ | N/A | +| `Primeintellect` | map[string]`any` | ➖ | N/A | +| `Quiver` | map[string]`any` | ➖ | N/A | +| `Recraft` | map[string]`any` | ➖ | N/A | +| `Recursal` | map[string]`any` | ➖ | N/A | +| `Reflection` | map[string]`any` | ➖ | N/A | +| `Reka` | map[string]`any` | ➖ | N/A | +| `Relace` | map[string]`any` | ➖ | N/A | +| `Replicate` | map[string]`any` | ➖ | N/A | +| `Respan` | map[string]`any` | ➖ | N/A | +| `Runway` | map[string]`any` | ➖ | N/A | +| `SailResearch` | map[string]`any` | ➖ | N/A | +| `Sakana` | map[string]`any` | ➖ | N/A | +| `SakanaAi` | map[string]`any` | ➖ | N/A | +| `Sambanova` | map[string]`any` | ➖ | N/A | +| `SambanovaCloaked` | map[string]`any` | ➖ | N/A | +| `Scaledown` | map[string]`any` | ➖ | N/A | +| `Seed` | map[string]`any` | ➖ | N/A | +| `SfCompute` | map[string]`any` | ➖ | N/A | +| `Siliconflow` | map[string]`any` | ➖ | N/A | +| `Sourceful` | map[string]`any` | ➖ | N/A | +| `Stealth` | map[string]`any` | ➖ | N/A | +| `Stepfun` | map[string]`any` | ➖ | N/A | +| `Streamlake` | map[string]`any` | ➖ | N/A | +| `Switchpoint` | map[string]`any` | ➖ | N/A | +| `Targon` | map[string]`any` | ➖ | N/A | +| `Tencent` | map[string]`any` | ➖ | N/A | +| `Tenstorrent` | map[string]`any` | ➖ | N/A | +| `Thinkingmachines` | map[string]`any` | ➖ | N/A | +| `Together` | map[string]`any` | ➖ | N/A | +| `TogetherLite` | map[string]`any` | ➖ | N/A | +| `Typesafe` | map[string]`any` | ➖ | N/A | +| `Ubicloud` | map[string]`any` | ➖ | N/A | +| `Unbiased` | map[string]`any` | ➖ | N/A | +| `Upstage` | map[string]`any` | ➖ | N/A | +| `Venice` | map[string]`any` | ➖ | N/A | +| `Voyageai` | map[string]`any` | ➖ | N/A | +| `Wafer` | map[string]`any` | ➖ | N/A | +| `Wandb` | map[string]`any` | ➖ | N/A | +| `WandbLegacy` | map[string]`any` | ➖ | N/A | +| `Xai` | map[string]`any` | ➖ | N/A | +| `Xiaomi` | map[string]`any` | ➖ | N/A | +| `ZAi` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/provideroverloadedresponseerrordata.mdx b/docs/models/components/provideroverloadedresponseerrordata.mdx index 5646fd73b..4b65aaacb 100644 --- a/docs/models/components/provideroverloadedresponseerrordata.mdx +++ b/docs/models/components/provideroverloadedresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ProviderOverloadedResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/providerpreferences.mdx b/docs/models/components/providerpreferences.mdx index 09dcd175f..e09dbc2d3 100644 --- a/docs/models/components/providerpreferences.mdx +++ b/docs/models/components/providerpreferences.mdx @@ -9,17 +9,17 @@ Provider routing preferences for the request. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `DataCollection` | optionalnullable.OptionalNullable[[components.DataCollection](../../models/components/datacollection.mdx)] | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `EnforceDistillableText` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | -| `Ignore` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesIgnore](../../models/components/providerpreferencesignore.mdx)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | -| `MaxPrice` | [*components.MaxPrice](../../models/components/maxprice.mdx) | :heavy_minus_sign: | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. | | -| `Only` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOnly](../../models/components/providerpreferencesonly.mdx)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | -| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `Order` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOrder](../../models/components/providerpreferencesorder.mdx)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | -| `PreferredMaxLatency` | optionalnullable.OptionalNullable[[components.PreferredMaxLatency](../../models/components/preferredmaxlatency.mdx)] | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | -| `PreferredMinThroughput` | optionalnullable.OptionalNullable[[components.PreferredMinThroughput](../../models/components/preferredminthroughput.mdx)] | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | -| `Quantizations` | optionalnullable.OptionalNullable[[][components.Quantization](../../models/components/quantization.mdx)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `RequireParameters` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | -| `Sort` | optionalnullable.OptionalNullable[[components.ProviderPreferencesSort](../../models/components/providerpreferencessort.mdx)] | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | -| `Zdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `DataCollection` | optionalnullable.OptionalNullable[[components.DataCollection](../../models/components/datacollection.mdx)] | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `EnforceDistillableText` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | +| `Ignore` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesIgnore](../../models/components/providerpreferencesignore.mdx)] | ➖ | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | +| `MaxPrice` | [*components.MaxPrice](../../models/components/maxprice.mdx) | ➖ | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. | | +| `Only` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOnly](../../models/components/providerpreferencesonly.mdx)] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | +| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `Order` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOrder](../../models/components/providerpreferencesorder.mdx)] | ➖ | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | +| `PreferredMaxLatency` | optionalnullable.OptionalNullable[[components.PreferredMaxLatency](../../models/components/preferredmaxlatency.mdx)] | ➖ | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | +| `PreferredMinThroughput` | optionalnullable.OptionalNullable[[components.PreferredMinThroughput](../../models/components/preferredminthroughput.mdx)] | ➖ | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | +| `Quantizations` | optionalnullable.OptionalNullable[[][components.Quantization](../../models/components/quantization.mdx)] | ➖ | A list of quantization levels to filter the provider by. | | +| `RequireParameters` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | +| `Sort` | optionalnullable.OptionalNullable[[components.ProviderPreferencesSort](../../models/components/providerpreferencessort.mdx)] | ➖ | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | +| `Zdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/components/providerresponse.mdx b/docs/models/components/providerresponse.mdx index 3b9019d03..e2a04e148 100644 --- a/docs/models/components/providerresponse.mdx +++ b/docs/models/components/providerresponse.mdx @@ -9,11 +9,11 @@ Details of a provider response for a generation attempt | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `EndpointID` | `*string` | :heavy_minus_sign: | Internal endpoint identifier | ep_abc123 | -| `ID` | `*string` | :heavy_minus_sign: | Upstream provider response identifier | chatcmpl-abc123 | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | -| `Latency` | `*float64` | :heavy_minus_sign: | Response latency in milliseconds | 1200 | -| `ModelPermaslug` | `*string` | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | -| `ProviderName` | [*components.ProviderResponseProviderName](../../models/components/providerresponseprovidername.mdx) | :heavy_minus_sign: | Name of the provider | OpenAI | -| `RoutedServiceTier` | [*components.RoutedServiceTier](../../models/components/routedservicetier.mdx) | :heavy_minus_sign: | The service tier this request was routed to (e.g. flex, priority). The tier actually applied and billed is determined by the provider response and may differ. | priority | -| `Status` | `*int64` | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file +| `EndpointID` | `*string` | ➖ | Internal endpoint identifier | ep_abc123 | +| `ID` | `*string` | ➖ | Upstream provider response identifier | chatcmpl-abc123 | +| `IsBYOK` | `*bool` | ➖ | Whether the request used a bring-your-own-key | false | +| `Latency` | `*float64` | ➖ | Response latency in milliseconds | 1200 | +| `ModelPermaslug` | `*string` | ➖ | Canonical model slug | openai/gpt-4 | +| `ProviderName` | [*components.ProviderResponseProviderName](../../models/components/providerresponseprovidername.mdx) | ➖ | Name of the provider | OpenAI | +| `RoutedServiceTier` | [*components.RoutedServiceTier](../../models/components/routedservicetier.mdx) | ➖ | The service tier this request was routed to (e.g. flex, priority). The tier actually applied and billed is determined by the provider response and may differ. | priority | +| `Status` | `*int64` | ✅ | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/docs/models/components/providersortconfig.mdx b/docs/models/components/providersortconfig.mdx index aa7bef7f4..886518613 100644 --- a/docs/models/components/providersortconfig.mdx +++ b/docs/models/components/providersortconfig.mdx @@ -9,5 +9,5 @@ The provider sorting strategy (price, throughput, latency) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `By` | optionalnullable.OptionalNullable[[components.By](../../models/components/by.mdx)] | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | -| `Partition` | optionalnullable.OptionalNullable[[components.Partition](../../models/components/partition.mdx)] | :heavy_minus_sign: | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model | \ No newline at end of file +| `By` | optionalnullable.OptionalNullable[[components.By](../../models/components/by.mdx)] | ➖ | The provider sorting strategy (price, throughput, latency) | price | +| `Partition` | optionalnullable.OptionalNullable[[components.Partition](../../models/components/partition.mdx)] | ➖ | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model | \ No newline at end of file diff --git a/docs/models/components/provisioninternresponse.mdx b/docs/models/components/provisioninternresponse.mdx index 0b1066907..b66e8f3c4 100644 --- a/docs/models/components/provisioninternresponse.mdx +++ b/docs/models/components/provisioninternresponse.mdx @@ -6,4 +6,4 @@ title: "ProvisionInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Provisioning` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Provisioning` | `bool` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/publicendpoint.mdx b/docs/models/components/publicendpoint.mdx index fd59f8a65..96859bce0 100644 --- a/docs/models/components/publicendpoint.mdx +++ b/docs/models/components/publicendpoint.mdx @@ -9,27 +9,27 @@ Information about a specific model endpoint | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContextLength` | `int64` | :heavy_check_mark: | N/A | | -| `LatencyLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | Latency percentiles in milliseconds over the last 30 minutes. Latency measures time to first token. Only visible when authenticated with an API key or cookie; returns null for unauthenticated requests. | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `MaxCompletionTokens` | `*int64` | :heavy_check_mark: | Maximum completion tokens for this endpoint. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | | -| `MaxPromptTokens` | `*int64` | :heavy_check_mark: | N/A | | -| `ModelID` | `string` | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 | -| `ModelName` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `NativeTools` | map[string][components.NativeTools](../../models/components/nativetools.mdx) | :heavy_check_mark: | The server tools this endpoint accepts as the provider's own built-in tool (`engine: "native"`) instead of an OpenRouter engine, keyed by canonical `openrouter:*` name. Each value names the provider tool type the request is translated to. Where that tool runs (provider-side, or returned to the client as with Anthropic bash) is documented per tool. Empty when the provider has none. | \{
"openrouter:web_search": \{
"type": "web_search_20260209"
}
} | -| `PerfLast30mByWorkload` | [*components.PerfLast30mByWorkload](../../models/components/perflast30mbyworkload.mdx) | :heavy_minus_sign: | Endpoint performance over the last 30 minutes, keyed by the kind of request served (e.g. `text_generation`, `image_generation`). Additive to the legacy singular latency and throughput fields; image and video generation report end-to-end latency. Only visible when authenticated with an API key or cookie. | | -| `Pricing` | [components.Pricing](../../models/components/pricing.mdx) | :heavy_check_mark: | N/A | | -| `ProviderName` | [components.ProviderName](../../models/components/providername.mdx) | :heavy_check_mark: | N/A | OpenAI | -| `Quantization` | [*components.Quantization](../../models/components/quantization.mdx) | :heavy_check_mark: | N/A | fp16 | -| `Status` | [*components.EndpointStatus](../../models/components/endpointstatus.mdx) | :heavy_minus_sign: | N/A | 0 | -| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | :heavy_check_mark: | N/A | | -| `SupportsImageReference` | `*bool` | :heavy_minus_sign: | Whether this TTS endpoint accepts an `image_url` reference describing the desired voice. Requests carrying an image reference are only routed to endpoints where this is true. | | -| `SupportsImplicitCaching` | `bool` | :heavy_check_mark: | N/A | | -| `SupportsMultipleAudioReferences` | `*bool` | :heavy_minus_sign: | Whether this TTS endpoint accepts more than one `input_audio` reference clip per request. Requests carrying several clips are only routed to endpoints where this is true. | | -| `SupportsToolChoice` | [components.ToolChoiceSupport](../../models/components/toolchoicesupport.mdx) | :heavy_check_mark: | Per-variant `tool_choice` support. `tool_choice` in `supported_parameters` only says the parameter is accepted; these flags say which of its values passed testing. | \{
"auto": true,
"function": true,
"none": true,
"required": true
} | -| `SupportsVoiceCloning` | `*bool` | :heavy_minus_sign: | Whether this TTS endpoint accepts inline reference audio (`input_references`) for stateless voice cloning. Requests carrying reference audio are only routed to endpoints where this is true. | | -| `Tag` | `string` | :heavy_check_mark: | N/A | | -| `ThroughputLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `UptimeLast1d` | `*float64` | :heavy_check_mark: | Uptime percentage over the last day: the share of minutes in which at least 80% of provider attempts succeeded, counting only minutes with 10 or more attempts. Rate-limited and caller-caused failures are excluded. Null when no minute had enough traffic. | | -| `UptimeLast30m` | `*float64` | :heavy_check_mark: | N/A | | -| `UptimeLast5m` | `*float64` | :heavy_check_mark: | Uptime percentage over the last 5 minutes: the share of minutes in which at least 80% of provider attempts succeeded, counting only minutes with 10 or more attempts. Rate-limited and caller-caused failures are excluded. Null when no minute had enough traffic. | | \ No newline at end of file +| `ContextLength` | `int64` | ✅ | N/A | | +| `LatencyLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | Latency percentiles in milliseconds over the last 30 minutes. Latency measures time to first token. Only visible when authenticated with an API key or cookie; returns null for unauthenticated requests. | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `MaxCompletionTokens` | `*int64` | ✅ | Maximum completion tokens for this endpoint. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | | +| `MaxPromptTokens` | `*int64` | ✅ | N/A | | +| `ModelID` | `string` | ✅ | The unique identifier for the model (permaslug) | openai/gpt-4 | +| `ModelName` | `string` | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `NativeTools` | map[string][components.NativeTools](../../models/components/nativetools.mdx) | ✅ | The server tools this endpoint accepts as the provider's own built-in tool (`engine: "native"`) instead of an OpenRouter engine, keyed by canonical `openrouter:*` name. Each value names the provider tool type the request is translated to. Where that tool runs (provider-side, or returned to the client as with Anthropic bash) is documented per tool. Empty when the provider has none. | \{
"openrouter:web_search": \{
"type": "web_search_20260209"
}
} | +| `PerfLast30mByWorkload` | [*components.PerfLast30mByWorkload](../../models/components/perflast30mbyworkload.mdx) | ➖ | Endpoint performance over the last 30 minutes, keyed by the kind of request served (e.g. `text_generation`, `image_generation`). Additive to the legacy singular latency and throughput fields; image and video generation report end-to-end latency. Only visible when authenticated with an API key or cookie. | | +| `Pricing` | [components.Pricing](../../models/components/pricing.mdx) | ✅ | N/A | | +| `ProviderName` | [components.ProviderName](../../models/components/providername.mdx) | ✅ | N/A | OpenAI | +| `Quantization` | [*components.Quantization](../../models/components/quantization.mdx) | ✅ | N/A | fp16 | +| `Status` | [*components.EndpointStatus](../../models/components/endpointstatus.mdx) | ➖ | N/A | 0 | +| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | ✅ | N/A | | +| `SupportsImageReference` | `*bool` | ➖ | Whether this TTS endpoint accepts an `image_url` reference describing the desired voice. Requests carrying an image reference are only routed to endpoints where this is true. | | +| `SupportsImplicitCaching` | `bool` | ✅ | N/A | | +| `SupportsMultipleAudioReferences` | `*bool` | ➖ | Whether this TTS endpoint accepts more than one `input_audio` reference clip per request. Requests carrying several clips are only routed to endpoints where this is true. | | +| `SupportsToolChoice` | [components.ToolChoiceSupport](../../models/components/toolchoicesupport.mdx) | ✅ | Per-variant `tool_choice` support. `tool_choice` in `supported_parameters` only says the parameter is accepted; these flags say which of its values passed testing. | \{
"auto": true,
"function": true,
"none": true,
"required": true
} | +| `SupportsVoiceCloning` | `*bool` | ➖ | Whether this TTS endpoint accepts inline reference audio (`input_references`) for stateless voice cloning. Requests carrying reference audio are only routed to endpoints where this is true. | | +| `Tag` | `string` | ✅ | N/A | | +| `ThroughputLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `UptimeLast1d` | `*float64` | ✅ | Uptime percentage over the last day: the share of minutes in which at least 80% of provider attempts succeeded, counting only minutes with 10 or more attempts. Rate-limited and caller-caused failures are excluded. Null when no minute had enough traffic. | | +| `UptimeLast30m` | `*float64` | ✅ | N/A | | +| `UptimeLast5m` | `*float64` | ✅ | Uptime percentage over the last 5 minutes: the share of minutes in which at least 80% of provider attempts succeeded, counting only minutes with 10 or more attempts. Rate-limited and caller-caused failures are excluded. Null when no minute had enough traffic. | | \ No newline at end of file diff --git a/docs/models/components/publicpricing.mdx b/docs/models/components/publicpricing.mdx index 68789233c..79b50e554 100644 --- a/docs/models/components/publicpricing.mdx +++ b/docs/models/components/publicpricing.mdx @@ -9,19 +9,19 @@ Pricing information for the model | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Audio` | `*string` | :heavy_minus_sign: | Price in USD per audio input token | -| `AudioOutput` | `*string` | :heavy_minus_sign: | Price in USD per audio output token | -| `Completion` | `string` | :heavy_check_mark: | Price in USD per token for completion (output) generation | -| `Discount` | `*float64` | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `Image` | `*string` | :heavy_minus_sign: | Price in USD per input image | -| `ImageOutput` | `*string` | :heavy_minus_sign: | Price in USD per output image | -| `ImageToken` | `*string` | :heavy_minus_sign: | Price in USD per image token | -| `InputAudioCache` | `*string` | :heavy_minus_sign: | Price in USD per cached audio input token | -| `InputCacheRead` | `*string` | :heavy_minus_sign: | Price in USD per cached input token (read) | -| `InputCacheWrite` | `*string` | :heavy_minus_sign: | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | -| `InputCacheWrite1h` | `*string` | :heavy_minus_sign: | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | -| `InternalReasoning` | `*string` | :heavy_minus_sign: | Price in USD per internal reasoning token | -| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride.mdx) | :heavy_minus_sign: | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | -| `Prompt` | `string` | :heavy_check_mark: | Price in USD per token for prompt (input) processing | -| `Request` | `*string` | :heavy_minus_sign: | Price in USD per request | -| `WebSearch` | `*string` | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file +| `Audio` | `*string` | ➖ | Price in USD per audio input token | +| `AudioOutput` | `*string` | ➖ | Price in USD per audio output token | +| `Completion` | `string` | ✅ | Price in USD per token for completion (output) generation | +| `Discount` | `*float64` | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `Image` | `*string` | ➖ | Price in USD per input image | +| `ImageOutput` | `*string` | ➖ | Price in USD per output image | +| `ImageToken` | `*string` | ➖ | Price in USD per image token | +| `InputAudioCache` | `*string` | ➖ | Price in USD per cached audio input token | +| `InputCacheRead` | `*string` | ➖ | Price in USD per cached input token (read) | +| `InputCacheWrite` | `*string` | ➖ | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | +| `InputCacheWrite1h` | `*string` | ➖ | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | +| `InternalReasoning` | `*string` | ➖ | Price in USD per internal reasoning token | +| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride.mdx) | ➖ | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | +| `Prompt` | `string` | ✅ | Price in USD per token for prompt (input) processing | +| `Request` | `*string` | ➖ | Price in USD per request | +| `WebSearch` | `*string` | ➖ | Price in USD per web search | \ No newline at end of file diff --git a/docs/models/components/rangecapability.mdx b/docs/models/components/rangecapability.mdx index 14bda3435..041f8cca8 100644 --- a/docs/models/components/rangecapability.mdx +++ b/docs/models/components/rangecapability.mdx @@ -9,6 +9,6 @@ A parameter that accepts any value within an inclusive numeric range. | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Max` | `float64` | :heavy_check_mark: | N/A | -| `Min` | `float64` | :heavy_check_mark: | N/A | -| `Type` | [components.RangeCapabilityType](../../models/components/rangecapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Max` | `float64` | ✅ | N/A | +| `Min` | `float64` | ✅ | N/A | +| `Type` | [components.RangeCapabilityType](../../models/components/rangecapabilitytype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/rankingoptions.mdx b/docs/models/components/rankingoptions.mdx index 0ae1d4473..0acf112f1 100644 --- a/docs/models/components/rankingoptions.mdx +++ b/docs/models/components/rankingoptions.mdx @@ -6,5 +6,5 @@ title: "RankingOptions" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Ranker` | [*components.Ranker](../../models/components/ranker.mdx) | :heavy_minus_sign: | N/A | -| `ScoreThreshold` | `*float64` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Ranker` | [*components.Ranker](../../models/components/ranker.mdx) | ➖ | N/A | +| `ScoreThreshold` | `*float64` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/rankingsdailyitem.mdx b/docs/models/components/rankingsdailyitem.mdx index 6c3196e4d..706723e51 100644 --- a/docs/models/components/rankingsdailyitem.mdx +++ b/docs/models/components/rankingsdailyitem.mdx @@ -6,6 +6,6 @@ title: "RankingsDailyItem" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Date` | `string` | :heavy_check_mark: | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | -| `TotalTokens` | `string` | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file +| `Date` | `string` | ✅ | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | +| `ModelPermaslug` | `string` | ✅ | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | +| `TotalTokens` | `string` | ✅ | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/docs/models/components/rankingsdailymeta.mdx b/docs/models/components/rankingsdailymeta.mdx index 969521c40..f5445091b 100644 --- a/docs/models/components/rankingsdailymeta.mdx +++ b/docs/models/components/rankingsdailymeta.mdx @@ -6,7 +6,7 @@ title: "RankingsDailyMeta" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | :heavy_check_mark: | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00:00.000Z | -| `EndDate` | `string` | :heavy_check_mark: | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | -| `StartDate` | `string` | :heavy_check_mark: | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | -| `Version` | [components.RankingsDailyMetaVersion](../../models/components/rankingsdailymetaversion.mdx) | :heavy_check_mark: | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file +| `AsOf` | `string` | ✅ | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00:00.000Z | +| `EndDate` | `string` | ✅ | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | +| `StartDate` | `string` | ✅ | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | +| `Version` | [components.RankingsDailyMetaVersion](../../models/components/rankingsdailymetaversion.mdx) | ✅ | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file diff --git a/docs/models/components/rankingsdailyresponse.mdx b/docs/models/components/rankingsdailyresponse.mdx index 69b871773..cd53d9add 100644 --- a/docs/models/components/rankingsdailyresponse.mdx +++ b/docs/models/components/rankingsdailyresponse.mdx @@ -6,5 +6,5 @@ title: "RankingsDailyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.RankingsDailyItem](../../models/components/rankingsdailyitem.mdx) | :heavy_check_mark: | Up to 51 rows per day — the top 50 public models by `total_tokens` for each UTC calendar date in the window, plus one aggregated `other` row summing every model outside that top 50 (omitted when the long tail is empty). Rows are sorted by `date` ascending, then by `total_tokens` descending, with `other` pinned last within its date. Ties between real models break alphabetically on `model_permaslug` so the order is stable across requests. | | -| `Meta` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `Data` | [][components.RankingsDailyItem](../../models/components/rankingsdailyitem.mdx) | ✅ | Up to 51 rows per day — the top 50 public models by `total_tokens` for each UTC calendar date in the window, plus one aggregated `other` row summing every model outside that top 50 (omitted when the long tail is empty). Rows are sorted by `date` ascending, then by `total_tokens` descending, with `other` pinned last within its date. Ties between real models break alphabetically on `model_permaslug` so the order is stable across requests. | | +| `Meta` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | ✅ | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/components/reasoningconfig.mdx b/docs/models/components/reasoningconfig.mdx index be18c63d1..5841935d4 100644 --- a/docs/models/components/reasoningconfig.mdx +++ b/docs/models/components/reasoningconfig.mdx @@ -6,9 +6,9 @@ title: "ReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext.mdx)] | :heavy_minus_sign: | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | -| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | :heavy_minus_sign: | N/A | medium | -| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode.mdx)] | :heavy_minus_sign: | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | -| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | :heavy_minus_sign: | N/A | auto | -| `Enabled` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext.mdx)] | ➖ | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | +| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | ➖ | N/A | medium | +| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode.mdx)] | ➖ | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | +| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | ➖ | N/A | auto | +| `Enabled` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdeltaevent.mdx b/docs/models/components/reasoningdeltaevent.mdx index 6d30d8903..b873f0a17 100644 --- a/docs/models/components/reasoningdeltaevent.mdx +++ b/docs/models/components/reasoningdeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning text delta is streamed | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningDeltaEventType](../../models/components/reasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | ✅ | N/A | +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.ReasoningDeltaEventType](../../models/components/reasoningdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailencrypted.mdx b/docs/models/components/reasoningdetailencrypted.mdx index 29b6a2c11..1bc3f1123 100644 --- a/docs/models/components/reasoningdetailencrypted.mdx +++ b/docs/models/components/reasoningdetailencrypted.mdx @@ -9,8 +9,8 @@ Reasoning detail encrypted schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Index` | `*int64` | :heavy_minus_sign: | N/A | | -| `Type` | [components.ReasoningDetailEncryptedType](../../models/components/reasoningdetailencryptedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Data` | `string` | ✅ | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Index` | `*int64` | ➖ | N/A | | +| `Type` | [components.ReasoningDetailEncryptedType](../../models/components/reasoningdetailencryptedtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailservertoolcall.mdx b/docs/models/components/reasoningdetailservertoolcall.mdx index fbfa24ee1..b170367b3 100644 --- a/docs/models/components/reasoningdetailservertoolcall.mdx +++ b/docs/models/components/reasoningdetailservertoolcall.mdx @@ -9,11 +9,11 @@ Record of an OpenRouter server-tool invocation (e.g. openrouter:fusion), carried | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Index` | `*int64` | :heavy_minus_sign: | N/A | | -| `Result` | `string` | :heavy_check_mark: | N/A | | -| `ToolCallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ToolName` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningDetailServerToolCallType](../../models/components/reasoningdetailservertoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Arguments` | `string` | ✅ | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Index` | `*int64` | ➖ | N/A | | +| `Result` | `string` | ✅ | N/A | | +| `ToolCallID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ToolName` | `string` | ✅ | N/A | | +| `Type` | [components.ReasoningDetailServerToolCallType](../../models/components/reasoningdetailservertoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailsummary.mdx b/docs/models/components/reasoningdetailsummary.mdx index 27d2e923d..fbc66d186 100644 --- a/docs/models/components/reasoningdetailsummary.mdx +++ b/docs/models/components/reasoningdetailsummary.mdx @@ -9,8 +9,8 @@ Reasoning detail summary schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Index` | `*int64` | :heavy_minus_sign: | N/A | | -| `Summary` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningDetailSummaryType](../../models/components/reasoningdetailsummarytype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Index` | `*int64` | ➖ | N/A | | +| `Summary` | `string` | ✅ | N/A | | +| `Type` | [components.ReasoningDetailSummaryType](../../models/components/reasoningdetailsummarytype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailtext.mdx b/docs/models/components/reasoningdetailtext.mdx index 2a8540c9f..3d0608cce 100644 --- a/docs/models/components/reasoningdetailtext.mdx +++ b/docs/models/components/reasoningdetailtext.mdx @@ -9,9 +9,9 @@ Reasoning detail text schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Index` | `*int64` | :heavy_minus_sign: | N/A | | -| `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Text` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.ReasoningDetailTextType](../../models/components/reasoningdetailtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Index` | `*int64` | ➖ | N/A | | +| `Signature` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Text` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Type` | [components.ReasoningDetailTextType](../../models/components/reasoningdetailtexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdoneevent.mdx b/docs/models/components/reasoningdoneevent.mdx index 154d52c52..c1a990496 100644 --- a/docs/models/components/reasoningdoneevent.mdx +++ b/docs/models/components/reasoningdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning text streaming is complete | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningDoneEventType](../../models/components/reasoningdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.ReasoningDoneEventType](../../models/components/reasoningdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningitem.mdx b/docs/models/components/reasoningitem.mdx index 436dee9e7..c96f38314 100644 --- a/docs/models/components/reasoningitem.mdx +++ b/docs/models/components/reasoningitem.mdx @@ -9,11 +9,11 @@ Reasoning output item with signature and format extensions | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | -| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [*components.ReasoningItemStatusUnion](../../models/components/reasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningItemType](../../models/components/reasoningitemtype.mdx) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | -| `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | ➖ | N/A | | +| `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `ID` | `string` | ✅ | N/A | | +| `Status` | [*components.ReasoningItemStatusUnion](../../models/components/reasoningitemstatusunion.mdx) | ➖ | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | | +| `Type` | [components.ReasoningItemType](../../models/components/reasoningitemtype.mdx) | ✅ | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | ➖ | N/A | unknown | +| `Signature` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarypartaddedevent.mdx b/docs/models/components/reasoningsummarypartaddedevent.mdx index 6b89dae44..88e58daae 100644 --- a/docs/models/components/reasoningsummarypartaddedevent.mdx +++ b/docs/models/components/reasoningsummarypartaddedevent.mdx @@ -9,9 +9,9 @@ Event emitted when a reasoning summary part is added | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningSummaryPartAddedEventType](../../models/components/reasoningsummarypartaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | | +| `OutputIndex` | `int64` | ✅ | N/A | | +| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `SummaryIndex` | `int64` | ✅ | N/A | | +| `Type` | [components.ReasoningSummaryPartAddedEventType](../../models/components/reasoningsummarypartaddedeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarypartdoneevent.mdx b/docs/models/components/reasoningsummarypartdoneevent.mdx index ef0f09aae..a1c758b8a 100644 --- a/docs/models/components/reasoningsummarypartdoneevent.mdx +++ b/docs/models/components/reasoningsummarypartdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when a reasoning summary part is complete | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | :heavy_check_mark: | N/A | | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningSummaryPartDoneEventType](../../models/components/reasoningsummarypartdoneeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | | +| `OutputIndex` | `int64` | ✅ | N/A | | +| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `SummaryIndex` | `int64` | ✅ | N/A | | +| `Type` | [components.ReasoningSummaryPartDoneEventType](../../models/components/reasoningsummarypartdoneeventtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytext.mdx b/docs/models/components/reasoningsummarytext.mdx index 209174746..c5551c16e 100644 --- a/docs/models/components/reasoningsummarytext.mdx +++ b/docs/models/components/reasoningsummarytext.mdx @@ -6,5 +6,5 @@ title: "ReasoningSummaryText" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextType](../../models/components/reasoningsummarytexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.ReasoningSummaryTextType](../../models/components/reasoningsummarytexttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytextdeltaevent.mdx b/docs/models/components/reasoningsummarytextdeltaevent.mdx index f79a9e10c..79da2425a 100644 --- a/docs/models/components/reasoningsummarytextdeltaevent.mdx +++ b/docs/models/components/reasoningsummarytextdeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning summary text delta is streamed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextDeltaEventType](../../models/components/reasoningsummarytextdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `SummaryIndex` | `int64` | ✅ | N/A | +| `Type` | [components.ReasoningSummaryTextDeltaEventType](../../models/components/reasoningsummarytextdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytextdoneevent.mdx b/docs/models/components/reasoningsummarytextdoneevent.mdx index 9692b4b60..1b85d9efc 100644 --- a/docs/models/components/reasoningsummarytextdoneevent.mdx +++ b/docs/models/components/reasoningsummarytextdoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when reasoning summary text streaming is complete | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextDoneEventType](../../models/components/reasoningsummarytextdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `SummaryIndex` | `int64` | ✅ | N/A | +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.ReasoningSummaryTextDoneEventType](../../models/components/reasoningsummarytextdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningtextcontent.mdx b/docs/models/components/reasoningtextcontent.mdx index cce8e4aa7..1037d3ad6 100644 --- a/docs/models/components/reasoningtextcontent.mdx +++ b/docs/models/components/reasoningtextcontent.mdx @@ -6,5 +6,5 @@ title: "ReasoningTextContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningTextContentType](../../models/components/reasoningtextcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.ReasoningTextContentType](../../models/components/reasoningtextcontenttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/refusal.mdx b/docs/models/components/refusal.mdx index fc4089d59..1aac47f68 100644 --- a/docs/models/components/refusal.mdx +++ b/docs/models/components/refusal.mdx @@ -6,7 +6,7 @@ title: "Refusal" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | -| `TopLogprobs` | [][components.RefusalTopLogprob](../../models/components/refusaltoplogprob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ✅ | N/A | +| `Logprob` | `float64` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | +| `TopLogprobs` | [][components.RefusalTopLogprob](../../models/components/refusaltoplogprob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/refusaldeltaevent.mdx b/docs/models/components/refusaldeltaevent.mdx index 1a2213c7c..8c9c2f30f 100644 --- a/docs/models/components/refusaldeltaevent.mdx +++ b/docs/models/components/refusaldeltaevent.mdx @@ -9,9 +9,9 @@ Event emitted when a refusal delta is streamed | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.RefusalDeltaEventType](../../models/components/refusaldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | ✅ | N/A | +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.RefusalDeltaEventType](../../models/components/refusaldeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/refusaldoneevent.mdx b/docs/models/components/refusaldoneevent.mdx index d4eaeff06..7c6ab6526 100644 --- a/docs/models/components/refusaldoneevent.mdx +++ b/docs/models/components/refusaldoneevent.mdx @@ -9,9 +9,9 @@ Event emitted when refusal streaming is complete | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `Refusal` | `string` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.RefusalDoneEventType](../../models/components/refusaldoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `Refusal` | `string` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.RefusalDoneEventType](../../models/components/refusaldoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/refusaltoplogprob.mdx b/docs/models/components/refusaltoplogprob.mdx index fe97c5092..3436f87c5 100644 --- a/docs/models/components/refusaltoplogprob.mdx +++ b/docs/models/components/refusaltoplogprob.mdx @@ -6,6 +6,6 @@ title: "RefusalTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ✅ | N/A | +| `Logprob` | `float64` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/request.mdx b/docs/models/components/request.mdx index db171aef5..66c917fba 100644 --- a/docs/models/components/request.mdx +++ b/docs/models/components/request.mdx @@ -6,5 +6,5 @@ title: "Request" | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `Body` | map[string]`any` | :heavy_check_mark: | Request payload for the batch `endpoint`. | -| `CustomID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Body` | map[string]`any` | ✅ | Request payload for the batch `endpoint`. | +| `CustomID` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/requesttimeoutresponseerrordata.mdx b/docs/models/components/requesttimeoutresponseerrordata.mdx index d49e08c06..2939b6fa3 100644 --- a/docs/models/components/requesttimeoutresponseerrordata.mdx +++ b/docs/models/components/requesttimeoutresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for RequestTimeoutResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/requireapproval.mdx b/docs/models/components/requireapproval.mdx index da9605a26..f926d7023 100644 --- a/docs/models/components/requireapproval.mdx +++ b/docs/models/components/requireapproval.mdx @@ -6,5 +6,5 @@ title: "RequireApproval" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Always` | [*components.Always](../../models/components/always.mdx) | :heavy_minus_sign: | N/A | -| `Never` | [*components.Never](../../models/components/never.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Always` | [*components.Always](../../models/components/always.mdx) | ➖ | N/A | +| `Never` | [*components.Never](../../models/components/never.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/rerank.mdx b/docs/models/components/rerank.mdx index bea622f31..86b063287 100644 --- a/docs/models/components/rerank.mdx +++ b/docs/models/components/rerank.mdx @@ -6,6 +6,6 @@ title: "Rerank" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/responsehealingplugin.mdx b/docs/models/components/responsehealingplugin.mdx index 6ca7b323d..b32c47cf5 100644 --- a/docs/models/components/responsehealingplugin.mdx +++ b/docs/models/components/responsehealingplugin.mdx @@ -6,5 +6,5 @@ title: "ResponseHealingPlugin" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | -| `ID` | [components.ResponseHealingPluginID](../../models/components/responsehealingpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | Set to false to disable the response-healing plugin for this request. Defaults to true. | +| `ID` | [components.ResponseHealingPluginID](../../models/components/responsehealingpluginid.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/responseoutputtext.mdx b/docs/models/components/responseoutputtext.mdx index 41a039c71..06ad559e2 100644 --- a/docs/models/components/responseoutputtext.mdx +++ b/docs/models/components/responseoutputtext.mdx @@ -6,7 +6,7 @@ title: "ResponseOutputText" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Annotations` | [][components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | :heavy_minus_sign: | N/A | -| `Logprobs` | [][components.Logprob](../../models/components/logprob.mdx) | :heavy_minus_sign: | N/A | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ResponseOutputTextType](../../models/components/responseoutputtexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Annotations` | [][components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | ➖ | N/A | +| `Logprobs` | [][components.Logprob](../../models/components/logprob.mdx) | ➖ | N/A | +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.ResponseOutputTextType](../../models/components/responseoutputtexttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/responseoutputtexttoplogprob.mdx b/docs/models/components/responseoutputtexttoplogprob.mdx index ccf5cb7ce..70fbe7cad 100644 --- a/docs/models/components/responseoutputtexttoplogprob.mdx +++ b/docs/models/components/responseoutputtexttoplogprob.mdx @@ -6,6 +6,6 @@ title: "ResponseOutputTextTopLogprob" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ✅ | N/A | +| `Logprob` | `float64` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/responsesrequest.mdx b/docs/models/components/responsesrequest.mdx index 67c22a533..30b22dc43 100644 --- a/docs/models/components/responsesrequest.mdx +++ b/docs/models/components/responsesrequest.mdx @@ -9,42 +9,42 @@ Request schema for Responses endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Background` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Debug` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | -| `Include` | optionalnullable.OptionalNullable[[][components.ResponseIncludesEnum](../../models/components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | -| `Input` | [*components.InputsUnion](../../models/components/inputsunion.mdx) | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum number of server-tool (e.g. `openrouter:web_search`) agent steps the model may take during a request. Defaults to 30, which is also the maximum. Ignored when `stop_server_tools_when` is set. | 30 | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | -| `Modalities` | [][components.OutputModalityEnum](../../models/components/outputmodalityenum.mdx) | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `Model` | `*string` | :heavy_minus_sign: | N/A | | -| `Models` | []`string` | :heavy_minus_sign: | N/A | | -| `ParallelToolCalls` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `Plugins` | [][components.ResponsesRequestPlugin](../../models/components/responsesrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `PreviousResponseID` | `any` | :heavy_minus_sign: | Not supported on this proxy. Each response request is independent: no responses are stored, so a previous response cannot be referenced. Requests with a non-null value are rejected with a 400 error. Send the full conversation history in `input` instead. | | -| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `Reasoning` | optionalnullable.OptionalNullable[[components.ReasoningConfig](../../models/components/reasoningconfig.mdx)] | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Recommended per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | -| `ServiceTier` | optionalnullable.OptionalNullable[[components.ResponsesRequestServiceTier](../../models/components/responsesrequestservicetier.mdx)] | :heavy_minus_sign: | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `Store` | `*bool` | :heavy_minus_sign: | N/A | | -| `Stream` | `*bool` | :heavy_minus_sign: | N/A | | -| `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `ToolChoice` | [*components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | -| `Tools` | [][components.ResponsesRequestToolUnion](../../models/components/responsesrequesttoolunion.mdx) | :heavy_minus_sign: | N/A | | -| `TopK` | `*int64` | :heavy_minus_sign: | N/A | | -| `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `Truncation` | optionalnullable.OptionalNullable[[components.OpenAIResponsesTruncation](../../models/components/openairesponsestruncation.mdx)] | :heavy_minus_sign: | N/A | auto | -| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file +| `Background` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Debug` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | +| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | ➖ | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | +| `Include` | optionalnullable.OptionalNullable[[][components.ResponseIncludesEnum](../../models/components/responseincludesenum.mdx)] | ➖ | N/A | | +| `Input` | [*components.InputsUnion](../../models/components/inputsunion.mdx) | ➖ | Input for a response request - can be a string or array of items | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `Instructions` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | +| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum number of server-tool (e.g. `openrouter:web_search`) agent steps the model may take during a request. Defaults to 30, which is also the maximum. Ignored when `stop_server_tools_when` is set. | 30 | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`string`] | ➖ | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | +| `Modalities` | [][components.OutputModalityEnum](../../models/components/outputmodalityenum.mdx) | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `Model` | `*string` | ➖ | N/A | | +| `Models` | []`string` | ➖ | N/A | | +| `ParallelToolCalls` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `Plugins` | [][components.ResponsesRequestPlugin](../../models/components/responsesrequestplugin.mdx) | ➖ | Plugins you want to enable for this request, including their settings. | | +| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | +| `PreviousResponseID` | `any` | ➖ | Not supported on this proxy. Each response request is independent: no responses are stored, so a previous response cannot be referenced. Requests with a non-null value are rejected with a 400 error. Send the full conversation history in `input` instead. | | +| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions.mdx)] | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `Reasoning` | optionalnullable.OptionalNullable[[components.ReasoningConfig](../../models/components/reasoningconfig.mdx)] | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | ➖ | Recommended per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | +| `ServiceTier` | optionalnullable.OptionalNullable[[components.ResponsesRequestServiceTier](../../models/components/responsesrequestservicetier.mdx)] | ➖ | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `Store` | `*bool` | ➖ | N/A | | +| `Stream` | `*bool` | ➖ | N/A | | +| `Temperature` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | +| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `ToolChoice` | [*components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | ➖ | N/A | auto | +| `Tools` | [][components.ResponsesRequestToolUnion](../../models/components/responsesrequesttoolunion.mdx) | ➖ | N/A | | +| `TopK` | `*int64` | ➖ | N/A | | +| `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | +| `TopP` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `Truncation` | optionalnullable.OptionalNullable[[components.OpenAIResponsesTruncation](../../models/components/openairesponsestruncation.mdx)] | ➖ | N/A | auto | +| `User` | `*string` | ➖ | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file diff --git a/docs/models/components/responsesrequesttoolfunction.mdx b/docs/models/components/responsesrequesttoolfunction.mdx index a7c560c98..e021df93e 100644 --- a/docs/models/components/responsesrequesttoolfunction.mdx +++ b/docs/models/components/responsesrequesttoolfunction.mdx @@ -9,10 +9,10 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.ResponsesRequestType](../../models/components/responsesrequesttype.mdx) | :heavy_check_mark: | N/A | | -| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Parameters` | map[string]`any` | ✅ | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `Type` | [components.ResponsesRequestType](../../models/components/responsesrequesttype.mdx) | ✅ | N/A | | +| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/components/responsesstreamingresponse.mdx b/docs/models/components/responsesstreamingresponse.mdx index 19b424ff7..938e32451 100644 --- a/docs/models/components/responsesstreamingresponse.mdx +++ b/docs/models/components/responsesstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ResponsesStreamingResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.StreamEvents](../../models/components/streamevents.mdx) | :heavy_check_mark: | Union of all possible event types emitted during response streaming | \{
"response": \{
"completed_at": null,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "in_progress",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null
},
"sequence_number": 0,
"type": "response.created"
} | \ No newline at end of file +| `Data` | [components.StreamEvents](../../models/components/streamevents.mdx) | ✅ | Union of all possible event types emitted during response streaming | \{
"response": \{
"completed_at": null,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "in_progress",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null
},
"sequence_number": 0,
"type": "response.created"
} | \ No newline at end of file diff --git a/docs/models/components/result.mdx b/docs/models/components/result.mdx index 53310a7bd..81e3cb179 100644 --- a/docs/models/components/result.mdx +++ b/docs/models/components/result.mdx @@ -6,7 +6,7 @@ title: "Result" | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `CustomID` | `string` | :heavy_check_mark: | N/A | -| `Error` | [*components.ResultError](../../models/components/resulterror.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Response` | [*components.BatchObjectResponse](../../models/components/batchobjectresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CustomID` | `string` | ✅ | N/A | +| `Error` | [*components.ResultError](../../models/components/resulterror.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Response` | [*components.BatchObjectResponse](../../models/components/batchobjectresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/resulterror.mdx b/docs/models/components/resulterror.mdx index 73afd94b6..869c3b692 100644 --- a/docs/models/components/resulterror.mdx +++ b/docs/models/components/resulterror.mdx @@ -6,7 +6,7 @@ title: "ResultError" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `Message` | `string` | :heavy_check_mark: | N/A | | -| `Param` | `*string` | :heavy_check_mark: | N/A | | -| `Type` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `Message` | `string` | ✅ | N/A | | +| `Param` | `*string` | ✅ | N/A | | +| `Type` | `string` | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/routerattempt.mdx b/docs/models/components/routerattempt.mdx index 0335b6ccf..d2cff8aa2 100644 --- a/docs/models/components/routerattempt.mdx +++ b/docs/models/components/routerattempt.mdx @@ -6,6 +6,6 @@ title: "RouterAttempt" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Provider` | `string` | :heavy_check_mark: | N/A | -| `Status` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Model` | `string` | ✅ | N/A | +| `Provider` | `string` | ✅ | N/A | +| `Status` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/routerparams.mdx b/docs/models/components/routerparams.mdx index 538d4b72d..45e2a55dc 100644 --- a/docs/models/components/routerparams.mdx +++ b/docs/models/components/routerparams.mdx @@ -6,7 +6,7 @@ title: "RouterParams" | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `QualityFloor` | `*float64` | :heavy_minus_sign: | N/A | | -| `ThroughputFloor` | `*float64` | :heavy_minus_sign: | N/A | | -| `VersionGroup` | `*string` | :heavy_minus_sign: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file +| `QualityFloor` | `*float64` | ➖ | N/A | | +| `ThroughputFloor` | `*float64` | ➖ | N/A | | +| `VersionGroup` | `*string` | ➖ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file diff --git a/docs/models/components/rule.mdx b/docs/models/components/rule.mdx index 5f0969ebf..60fcf3324 100644 --- a/docs/models/components/rule.mdx +++ b/docs/models/components/rule.mdx @@ -6,6 +6,6 @@ title: "Rule" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Field` | [components.Field](../../models/components/field.mdx) | :heavy_check_mark: | N/A | -| `Operator` | [components.Operator](../../models/components/operator.mdx) | :heavy_check_mark: | N/A | -| `Value` | [*components.ObservabilityFilterRuleGroupValue](../../models/components/observabilityfilterrulegroupvalue.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Field` | [components.Field](../../models/components/field.mdx) | ✅ | N/A | +| `Operator` | [components.Operator](../../models/components/operator.mdx) | ✅ | N/A | +| `Value` | [*components.ObservabilityFilterRuleGroupValue](../../models/components/observabilityfilterrulegroupvalue.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/scimgroup.mdx b/docs/models/components/scimgroup.mdx index 5d9ced078..b20ed17b5 100644 --- a/docs/models/components/scimgroup.mdx +++ b/docs/models/components/scimgroup.mdx @@ -6,9 +6,9 @@ title: "ScimGroup" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | -| `DisplayName` | `string` | :heavy_check_mark: | N/A | -| `ExternalID` | `*string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `OrganizationID` | `string` | :heavy_check_mark: | N/A | -| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | N/A | +| `DisplayName` | `string` | ✅ | N/A | +| `ExternalID` | `*string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `OrganizationID` | `string` | ✅ | N/A | +| `UpdatedAt` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/scimgroupmapping.mdx b/docs/models/components/scimgroupmapping.mdx index 3d314dd09..5e8846fb2 100644 --- a/docs/models/components/scimgroupmapping.mdx +++ b/docs/models/components/scimgroupmapping.mdx @@ -6,10 +6,10 @@ title: "ScimGroupMapping" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `OrganizationID` | `string` | :heavy_check_mark: | N/A | -| `Role` | [components.ScimGroupMappingRole](../../models/components/scimgroupmappingrole.mdx) | :heavy_check_mark: | N/A | -| `ScimGroupID` | `string` | :heavy_check_mark: | N/A | -| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | -| `WorkspaceID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `OrganizationID` | `string` | ✅ | N/A | +| `Role` | [components.ScimGroupMappingRole](../../models/components/scimgroupmappingrole.mdx) | ✅ | N/A | +| `ScimGroupID` | `string` | ✅ | N/A | +| `UpdatedAt` | `string` | ✅ | N/A | +| `WorkspaceID` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/scimsyncjob.mdx b/docs/models/components/scimsyncjob.mdx index 4815f0cc9..1578d9ab2 100644 --- a/docs/models/components/scimsyncjob.mdx +++ b/docs/models/components/scimsyncjob.mdx @@ -6,11 +6,11 @@ title: "ScimSyncJob" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | Time when the sync job was created. | -| `DeletedGroups` | `*int64` | :heavy_check_mark: | Number of groups deleted, when the job completed successfully. | -| `ErrorMessage` | `*string` | :heavy_check_mark: | Stable error message when the job failed. | -| `FinishedAt` | `*string` | :heavy_check_mark: | Time when synchronization finished. | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the sync job. | -| `StartedAt` | `*string` | :heavy_check_mark: | Time when synchronization started. | -| `Status` | [components.ScimSyncJobStatus](../../models/components/scimsyncjobstatus.mdx) | :heavy_check_mark: | Current status of the sync job: queued, running, succeeded, or failed. | -| `SyncedGroups` | `*int64` | :heavy_check_mark: | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | Time when the sync job was created. | +| `DeletedGroups` | `*int64` | ✅ | Number of groups deleted, when the job completed successfully. | +| `ErrorMessage` | `*string` | ✅ | Stable error message when the job failed. | +| `FinishedAt` | `*string` | ✅ | Time when synchronization finished. | +| `ID` | `string` | ✅ | Unique identifier for the sync job. | +| `StartedAt` | `*string` | ✅ | Time when synchronization started. | +| `Status` | [components.ScimSyncJobStatus](../../models/components/scimsyncjobstatus.mdx) | ✅ | Current status of the sync job: queued, running, succeeded, or failed. | +| `SyncedGroups` | `*int64` | ✅ | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file diff --git a/docs/models/components/searchmodelsservertoolconfig.mdx b/docs/models/components/searchmodelsservertoolconfig.mdx index cbde7e888..7e3f9d02a 100644 --- a/docs/models/components/searchmodelsservertoolconfig.mdx +++ b/docs/models/components/searchmodelsservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:experimental__search_models server tool | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file +| `MaxResults` | `*int64` | ➖ | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file diff --git a/docs/models/components/searchmodelsservertoolopenrouter.mdx b/docs/models/components/searchmodelsservertoolopenrouter.mdx index 29bb89eba..304390773 100644 --- a/docs/models/components/searchmodelsservertoolopenrouter.mdx +++ b/docs/models/components/searchmodelsservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.SearchModelsServerToolOpenRouterType](../../models/components/searchmodelsservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.SearchModelsServerToolOpenRouterType](../../models/components/searchmodelsservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/security.mdx b/docs/models/components/security.mdx index 8015ad3c4..8801243a1 100644 --- a/docs/models/components/security.mdx +++ b/docs/models/components/security.mdx @@ -6,4 +6,4 @@ title: "Security" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `APIKey` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `APIKey` | `*string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/servertool.mdx b/docs/models/components/servertool.mdx index 1728fb988..b3997b2df 100644 --- a/docs/models/components/servertool.mdx +++ b/docs/models/components/servertool.mdx @@ -6,18 +6,18 @@ title: "ServerTool" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Aliases` | [][components.ServerToolInputName](../../models/components/servertoolinputname.mdx) | :heavy_check_mark: | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | -| `DefaultEngine` | `*string` | :heavy_check_mark: | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | -| `DocsURL` | `string` | :heavy_check_mark: | N/A | | -| `Engines` | [][components.ServerToolEngine](../../models/components/servertoolengine.mdx) | :heavy_check_mark: | N/A | | -| `FallbackEngine` | `*string` | :heavy_check_mark: | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | -| `ID` | `string` | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `InputSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `Name` | `string` | :heavy_check_mark: | N/A | Web search | -| `NativeSupport` | [components.ServerToolNativeSupport](../../models/components/servertoolnativesupport.mdx) | :heavy_check_mark: | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | -| `OutputSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `ParametersSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `Status` | [components.ServerToolStatus](../../models/components/servertoolstatus.mdx) | :heavy_check_mark: | N/A | active | -| `Summary` | `string` | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | -| `SupportedAPIFormats` | [][components.ServerToolSupportedAPIFormat](../../models/components/servertoolsupportedapiformat.mdx) | :heavy_check_mark: | N/A | | -| `ToolDescription` | `string` | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file +| `Aliases` | [][components.ServerToolInputName](../../models/components/servertoolinputname.mdx) | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | +| `DefaultEngine` | `*string` | ✅ | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | +| `DocsURL` | `string` | ✅ | N/A | | +| `Engines` | [][components.ServerToolEngine](../../models/components/servertoolengine.mdx) | ✅ | N/A | | +| `FallbackEngine` | `*string` | ✅ | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | +| `ID` | `string` | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `InputSchema` | map[string]`any` | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `Name` | `string` | ✅ | N/A | Web search | +| `NativeSupport` | [components.ServerToolNativeSupport](../../models/components/servertoolnativesupport.mdx) | ✅ | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | +| `OutputSchema` | map[string]`any` | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `ParametersSchema` | map[string]`any` | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `Status` | [components.ServerToolStatus](../../models/components/servertoolstatus.mdx) | ✅ | N/A | active | +| `Summary` | `string` | ✅ | One sentence for cards and search results; never sent to a model | | +| `SupportedAPIFormats` | [][components.ServerToolSupportedAPIFormat](../../models/components/servertoolsupportedapiformat.mdx) | ✅ | N/A | | +| `ToolDescription` | `string` | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/models/components/servertooldetails.mdx b/docs/models/components/servertooldetails.mdx index 57eccdd99..2881f17dd 100644 --- a/docs/models/components/servertooldetails.mdx +++ b/docs/models/components/servertooldetails.mdx @@ -6,18 +6,18 @@ title: "ServerToolDetails" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Aliases` | [][components.ServerToolInputName](../../models/components/servertoolinputname.mdx) | :heavy_check_mark: | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | -| `DefaultEngine` | `*string` | :heavy_check_mark: | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | -| `DocsURL` | `string` | :heavy_check_mark: | N/A | | -| `Engines` | [][components.ServerToolEngine](../../models/components/servertoolengine.mdx) | :heavy_check_mark: | N/A | | -| `FallbackEngine` | `*string` | :heavy_check_mark: | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | -| `ID` | `string` | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `InputSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `Name` | `string` | :heavy_check_mark: | N/A | Web search | -| `NativeSupport` | [components.NativeSupport](../../models/components/nativesupport.mdx) | :heavy_check_mark: | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | -| `OutputSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `ParametersSchema` | map[string]`any` | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `Status` | [components.ServerToolDetailsStatus](../../models/components/servertooldetailsstatus.mdx) | :heavy_check_mark: | N/A | active | -| `Summary` | `string` | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | -| `SupportedAPIFormats` | [][components.ServerToolDetailsSupportedAPIFormat](../../models/components/servertooldetailssupportedapiformat.mdx) | :heavy_check_mark: | N/A | | -| `ToolDescription` | `string` | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file +| `Aliases` | [][components.ServerToolInputName](../../models/components/servertoolinputname.mdx) | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | +| `DefaultEngine` | `*string` | ✅ | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | +| `DocsURL` | `string` | ✅ | N/A | | +| `Engines` | [][components.ServerToolEngine](../../models/components/servertoolengine.mdx) | ✅ | N/A | | +| `FallbackEngine` | `*string` | ✅ | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | +| `ID` | `string` | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `InputSchema` | map[string]`any` | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `Name` | `string` | ✅ | N/A | Web search | +| `NativeSupport` | [components.NativeSupport](../../models/components/nativesupport.mdx) | ✅ | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | +| `OutputSchema` | map[string]`any` | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `ParametersSchema` | map[string]`any` | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `Status` | [components.ServerToolDetailsStatus](../../models/components/servertooldetailsstatus.mdx) | ✅ | N/A | active | +| `Summary` | `string` | ✅ | One sentence for cards and search results; never sent to a model | | +| `SupportedAPIFormats` | [][components.ServerToolDetailsSupportedAPIFormat](../../models/components/servertooldetailssupportedapiformat.mdx) | ✅ | N/A | | +| `ToolDescription` | `string` | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/models/components/servertoolengine.mdx b/docs/models/components/servertoolengine.mdx index 153d0301a..1c5931a5b 100644 --- a/docs/models/components/servertoolengine.mdx +++ b/docs/models/components/servertoolengine.mdx @@ -6,12 +6,12 @@ title: "ServerToolEngine" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOK` | [components.BYOK](../../models/components/byok.mdx) | :heavy_check_mark: | Whether the engine needs the caller's own key, saved in plugin settings: `required` (OpenRouter holds none), `optional` (OpenRouter's key is used unless the caller saved one), or `none` | none | -| `DataRegions` | [][components.ServerToolEngineDataRegion](../../models/components/servertoolenginedataregion.mdx) | :heavy_check_mark: | The data regions whose requests this engine serves without leaving the region. A request pinned to a region can only use engines that list it; `global` is always listed. | [
"global",
"us"
] | -| `DefaultMode` | `*string` | :heavy_check_mark: | The `parameters.mode` a request without one runs and bills as; null for engines without modes. The `pricing[]` row with this `mode` is what an unmoded request bills | auto | -| `ExecutedBy` | [components.ServerToolExecutedBy](../../models/components/servertoolexecutedby.mdx) | :heavy_check_mark: | Who runs the tool call: the model provider during inference (`provider`), OpenRouter (`openrouter`), or the caller's application after the call is returned (`client`). | openrouter | -| `ID` | `*string` | :heavy_check_mark: | The `parameters.engine` value that selects this engine; null for the single engine of a tool without an engine parameter | exa | -| `Name` | `string` | :heavy_check_mark: | N/A | Exa | -| `Pricing` | [][components.ServerToolPrice](../../models/components/servertoolprice.mdx) | :heavy_check_mark: | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | -| `PricingDocURL` | `*string` | :heavy_check_mark: | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | -| `PricingSource` | [components.PricingSource](../../models/components/pricingsource.mdx) | :heavy_check_mark: | Who bills the engine's calls beyond the model's tokens: `openrouter` (the `pricing` rows, from the caller's credits), `provider` (a per-call tool fee from the model's provider on the inference call, at its own rates), `byok` (the engine's vendor, against the caller's own key), or `none` (no charge) | openrouter | \ No newline at end of file +| `BYOK` | [components.BYOK](../../models/components/byok.mdx) | ✅ | Whether the engine needs the caller's own key, saved in plugin settings: `required` (OpenRouter holds none), `optional` (OpenRouter's key is used unless the caller saved one), or `none` | none | +| `DataRegions` | [][components.ServerToolEngineDataRegion](../../models/components/servertoolenginedataregion.mdx) | ✅ | The data regions whose requests this engine serves without leaving the region. A request pinned to a region can only use engines that list it; `global` is always listed. | [
"global",
"us"
] | +| `DefaultMode` | `*string` | ✅ | The `parameters.mode` a request without one runs and bills as; null for engines without modes. The `pricing[]` row with this `mode` is what an unmoded request bills | auto | +| `ExecutedBy` | [components.ServerToolExecutedBy](../../models/components/servertoolexecutedby.mdx) | ✅ | Who runs the tool call: the model provider during inference (`provider`), OpenRouter (`openrouter`), or the caller's application after the call is returned (`client`). | openrouter | +| `ID` | `*string` | ✅ | The `parameters.engine` value that selects this engine; null for the single engine of a tool without an engine parameter | exa | +| `Name` | `string` | ✅ | N/A | Exa | +| `Pricing` | [][components.ServerToolPrice](../../models/components/servertoolprice.mdx) | ✅ | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | +| `PricingDocURL` | `*string` | ✅ | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | +| `PricingSource` | [components.PricingSource](../../models/components/pricingsource.mdx) | ✅ | Who bills the engine's calls beyond the model's tokens: `openrouter` (the `pricing` rows, from the caller's credits), `provider` (a per-call tool fee from the model's provider on the inference call, at its own rates), `byok` (the engine's vendor, against the caller's own key), or `none` (no charge) | openrouter | \ No newline at end of file diff --git a/docs/models/components/servertoolinputname.mdx b/docs/models/components/servertoolinputname.mdx index 0092ef47e..72b810202 100644 --- a/docs/models/components/servertoolinputname.mdx +++ b/docs/models/components/servertoolinputname.mdx @@ -6,6 +6,6 @@ title: "ServerToolInputName" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIFormats` | [][components.ServerToolInputNameAPIFormat](../../models/components/servertoolinputnameapiformat.mdx) | :heavy_check_mark: | API formats that accept this spelling in `tools[].type` | | -| `OutputNames` | [][components.ServerToolOutputName](../../models/components/servertooloutputname.mdx) | :heavy_check_mark: | What the call surfaces as on each accepting API format when requested under this spelling; a format is absent when the call is not visible to the caller | | -| `Type` | `string` | :heavy_check_mark: | N/A | web_search_20250305 | \ No newline at end of file +| `APIFormats` | [][components.ServerToolInputNameAPIFormat](../../models/components/servertoolinputnameapiformat.mdx) | ✅ | API formats that accept this spelling in `tools[].type` | | +| `OutputNames` | [][components.ServerToolOutputName](../../models/components/servertooloutputname.mdx) | ✅ | What the call surfaces as on each accepting API format when requested under this spelling; a format is absent when the call is not visible to the caller | | +| `Type` | `string` | ✅ | N/A | web_search_20250305 | \ No newline at end of file diff --git a/docs/models/components/servertoolnativemodel.mdx b/docs/models/components/servertoolnativemodel.mdx index d1184a9ae..32ad2ac70 100644 --- a/docs/models/components/servertoolnativemodel.mdx +++ b/docs/models/components/servertoolnativemodel.mdx @@ -6,5 +6,5 @@ title: "ServerToolNativeModel" | Field | Type | Required | Description | Example | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `Providers` | []`string` | :heavy_check_mark: | N/A | [
"Anthropic",
"Google"
] | -| `Slug` | `string` | :heavy_check_mark: | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file +| `Providers` | []`string` | ✅ | N/A | [
"Anthropic",
"Google"
] | +| `Slug` | `string` | ✅ | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file diff --git a/docs/models/components/servertoolnativesupport.mdx b/docs/models/components/servertoolnativesupport.mdx index a99eb2c60..c47ef8e64 100644 --- a/docs/models/components/servertoolnativesupport.mdx +++ b/docs/models/components/servertoolnativesupport.mdx @@ -9,5 +9,5 @@ Endpoints whose provider runs this tool itself during inference. Zero for tools | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `EndpointCount` | `int64` | :heavy_check_mark: | N/A | 18 | -| `ModelCount` | `int64` | :heavy_check_mark: | N/A | 12 | \ No newline at end of file +| `EndpointCount` | `int64` | ✅ | N/A | 18 | +| `ModelCount` | `int64` | ✅ | N/A | 12 | \ No newline at end of file diff --git a/docs/models/components/servertooloutputname.mdx b/docs/models/components/servertooloutputname.mdx index 91081a7ef..d6dd649e7 100644 --- a/docs/models/components/servertooloutputname.mdx +++ b/docs/models/components/servertooloutputname.mdx @@ -6,6 +6,6 @@ title: "ServerToolOutputName" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `APIFormat` | [components.ServerToolOutputNameAPIFormat](../../models/components/servertooloutputnameapiformat.mdx) | :heavy_check_mark: | N/A | | -| `Name` | `*string` | :heavy_minus_sign: | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | -| `Type` | `string` | :heavy_check_mark: | Output item `type` on Responses, content block `type` on Anthropic Messages, `reasoning_details[].type` on Chat Completions | web_search_call | \ No newline at end of file +| `APIFormat` | [components.ServerToolOutputNameAPIFormat](../../models/components/servertooloutputnameapiformat.mdx) | ✅ | N/A | | +| `Name` | `*string` | ➖ | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | +| `Type` | `string` | ✅ | Output item `type` on Responses, content block `type` on Anthropic Messages, `reasoning_details[].type` on Chat Completions | web_search_call | \ No newline at end of file diff --git a/docs/models/components/servertoolprice.mdx b/docs/models/components/servertoolprice.mdx index 1a81fcea2..5557c1b23 100644 --- a/docs/models/components/servertoolprice.mdx +++ b/docs/models/components/servertoolprice.mdx @@ -6,7 +6,7 @@ title: "ServerToolPrice" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `MaxUnitsPerCall` | `int64` | :heavy_check_mark: | N/A | | -| `Mode` | `*string` | :heavy_check_mark: | The `parameters.mode` this price applies to; null for prices that do not depend on the mode. A request bills exactly one `request` row | auto | -| `Price` | `string` | :heavy_check_mark: | USD per unit, as a decimal string | 0.007 | -| `Unit` | `string` | :heavy_check_mark: | N/A | request | \ No newline at end of file +| `MaxUnitsPerCall` | `int64` | ✅ | N/A | | +| `Mode` | `*string` | ✅ | The `parameters.mode` this price applies to; null for prices that do not depend on the mode. A request bills exactly one `request` row | auto | +| `Price` | `string` | ✅ | USD per unit, as a decimal string | 0.007 | +| `Unit` | `string` | ✅ | N/A | request | \ No newline at end of file diff --git a/docs/models/components/servertoolusedetails.mdx b/docs/models/components/servertoolusedetails.mdx index 3d5736d6c..e8da62873 100644 --- a/docs/models/components/servertoolusedetails.mdx +++ b/docs/models/components/servertoolusedetails.mdx @@ -9,6 +9,6 @@ Usage for server-side tool execution (e.g., web search) | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `ToolCallsExecuted` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `ToolCallsRequested` | optionalnullable.OptionalNullable[`int64`] | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `WebSearchRequests` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/components/serviceunavailableresponseerrordata.mdx b/docs/models/components/serviceunavailableresponseerrordata.mdx index 84bfea1cd..38f12700d 100644 --- a/docs/models/components/serviceunavailableresponseerrordata.mdx +++ b/docs/models/components/serviceunavailableresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for ServiceUnavailableResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/sessioncostitem.mdx b/docs/models/components/sessioncostitem.mdx index 473fd6fc6..b255e16b9 100644 --- a/docs/models/components/sessioncostitem.mdx +++ b/docs/models/components/sessioncostitem.mdx @@ -6,8 +6,8 @@ title: "SessionCostItem" | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `AppName` | `string` | :heavy_check_mark: | Published harness display label. | Hermes Agent | -| `AppSlug` | `string` | :heavy_check_mark: | Stable public slug of the harness. | hermes-agent | -| `MedianSessionCostUsd` | `float64` | :heavy_check_mark: | Median USD spend per sampled session. | 1.74 | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Exact model permaslug. | anthropic/claude-4.8-opus | -| `TurnRange` | [components.TurnRange](../../models/components/turnrange.mdx) | :heavy_check_mark: | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file +| `AppName` | `string` | ✅ | Published harness display label. | Hermes Agent | +| `AppSlug` | `string` | ✅ | Stable public slug of the harness. | hermes-agent | +| `MedianSessionCostUsd` | `float64` | ✅ | Median USD spend per sampled session. | 1.74 | +| `ModelPermaslug` | `string` | ✅ | Exact model permaslug. | anthropic/claude-4.8-opus | +| `TurnRange` | [components.TurnRange](../../models/components/turnrange.mdx) | ✅ | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file diff --git a/docs/models/components/sessioncostmeta.mdx b/docs/models/components/sessioncostmeta.mdx index 2d3e356d2..8c8480e48 100644 --- a/docs/models/components/sessioncostmeta.mdx +++ b/docs/models/components/sessioncostmeta.mdx @@ -6,7 +6,7 @@ title: "SessionCostMeta" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | :heavy_check_mark: | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | -| `Version` | [components.SessionCostMetaVersion](../../models/components/sessioncostmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | -| `WindowDays` | `*int64` | :heavy_check_mark: | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | -| `WindowEndDate` | `*string` | :heavy_check_mark: | UTC date of the final day in the session sample window, or null when no snapshot is published. | 2026-05-11 | \ No newline at end of file +| `AsOf` | `string` | ✅ | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | +| `Version` | [components.SessionCostMetaVersion](../../models/components/sessioncostmetaversion.mdx) | ✅ | Dataset version. | | +| `WindowDays` | `*int64` | ✅ | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | +| `WindowEndDate` | `*string` | ✅ | UTC date of the final day in the session sample window, or null when no snapshot is published. | 2026-05-11 | \ No newline at end of file diff --git a/docs/models/components/sessioncostresponse.mdx b/docs/models/components/sessioncostresponse.mdx index 20cc06fe3..71a436e3e 100644 --- a/docs/models/components/sessioncostresponse.mdx +++ b/docs/models/components/sessioncostresponse.mdx @@ -6,5 +6,5 @@ title: "SessionCostResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Data` | [][components.SessionCostItem](../../models/components/sessioncostitem.mdx) | :heavy_check_mark: | N/A | -| `Meta` | [components.SessionCostMeta](../../models/components/sessioncostmeta.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.SessionCostItem](../../models/components/sessioncostitem.mdx) | ✅ | N/A | +| `Meta` | [components.SessionCostMeta](../../models/components/sessioncostmeta.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/shellcallitem.mdx b/docs/models/components/shellcallitem.mdx index 8d477bc35..f4266f6e5 100644 --- a/docs/models/components/shellcallitem.mdx +++ b/docs/models/components/shellcallitem.mdx @@ -9,10 +9,10 @@ A shell command execution call (newer variant) | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ShellCallItemAction](../../models/components/shellcallitemaction.mdx) | :heavy_check_mark: | N/A | | -| `Arguments` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `Environment` | `any` | :heavy_minus_sign: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.ShellCallItemType](../../models/components/shellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Action` | [components.ShellCallItemAction](../../models/components/shellcallitemaction.mdx) | ✅ | N/A | | +| `Arguments` | optionalnullable.OptionalNullable[`string`] | ➖ | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | +| `CallID` | `string` | ✅ | N/A | | +| `Environment` | `any` | ➖ | N/A | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | +| `Type` | [components.ShellCallItemType](../../models/components/shellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/shellcallitemaction.mdx b/docs/models/components/shellcallitemaction.mdx index d982453e6..8bdbd9834 100644 --- a/docs/models/components/shellcallitemaction.mdx +++ b/docs/models/components/shellcallitemaction.mdx @@ -6,6 +6,6 @@ title: "ShellCallItemAction" | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `Commands` | []`string` | :heavy_check_mark: | N/A | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Commands` | []`string` | ✅ | N/A | +| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | +| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/shellcalloutputcontent.mdx b/docs/models/components/shellcalloutputcontent.mdx index db2108e40..605e929b2 100644 --- a/docs/models/components/shellcalloutputcontent.mdx +++ b/docs/models/components/shellcalloutputcontent.mdx @@ -9,7 +9,7 @@ Captured stdout and stderr for one command of a shell call, with its exit or tim | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Outcome` | [components.Outcome](../../models/components/outcome.mdx) | :heavy_check_mark: | N/A | | -| `Stderr` | `string` | :heavy_check_mark: | N/A | | -| `Stdout` | `string` | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"outcome": \{
"exit_code": 0,
"type": "exit"
},
"stderr": "",
"stdout": "total 0\n"
} | \ No newline at end of file +| `Outcome` | [components.Outcome](../../models/components/outcome.mdx) | ✅ | N/A | | +| `Stderr` | `string` | ✅ | N/A | | +| `Stdout` | `string` | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"outcome": \{
"exit_code": 0,
"type": "exit"
},
"stderr": "",
"stdout": "total 0\n"
} | \ No newline at end of file diff --git a/docs/models/components/shellcalloutputitem.mdx b/docs/models/components/shellcalloutputitem.mdx index be6a3f99f..729a14711 100644 --- a/docs/models/components/shellcalloutputitem.mdx +++ b/docs/models/components/shellcalloutputitem.mdx @@ -9,12 +9,12 @@ Output from a shell command execution (newer variant) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ContainerID` | `*string` | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `Error` | `*string` | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result, as echoed from a failed `shell_call_output` emission. | | -| `Files` | [][components.ShellCallOutputItemFile](../../models/components/shellcalloutputitemfile.mdx) | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.ShellCallOutputItemTypeShellCallOutput](../../models/components/shellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | | +| `ContainerID` | `*string` | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `Error` | `*string` | ➖ | The error message when the sandbox call failed before producing a result, as echoed from a failed `shell_call_output` emission. | | +| `Files` | [][components.ShellCallOutputItemFile](../../models/components/shellcalloutputitemfile.mdx) | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | +| `Output` | [][components.ShellCallOutputContent](../../models/components/shellcalloutputcontent.mdx) | ✅ | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | ➖ | N/A | completed | +| `Type` | [components.ShellCallOutputItemTypeShellCallOutput](../../models/components/shellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/shellcalloutputitemfile.mdx b/docs/models/components/shellcalloutputitemfile.mdx index 36662824e..13b9e14d6 100644 --- a/docs/models/components/shellcalloutputitemfile.mdx +++ b/docs/models/components/shellcalloutputitemfile.mdx @@ -6,9 +6,9 @@ title: "ShellCallOutputItemFile" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ShellCallOutputItemTypeContainerFileCitation](../../models/components/shellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContainerID` | `string` | ✅ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `FileID` | `string` | ✅ | N/A | +| `Filename` | `string` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Type` | [components.ShellCallOutputItemTypeContainerFileCitation](../../models/components/shellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/shellservertool.mdx b/docs/models/components/shellservertool.mdx index 951638529..c38b68ebb 100644 --- a/docs/models/components/shellservertool.mdx +++ b/docs/models/components/shellservertool.mdx @@ -9,4 +9,4 @@ Shell tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.ShellServerToolType](../../models/components/shellservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ShellServerToolType](../../models/components/shellservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/shellservertoolconfig.mdx b/docs/models/components/shellservertoolconfig.mdx index 9c2a6b2c1..c080ba848 100644 --- a/docs/models/components/shellservertoolconfig.mdx +++ b/docs/models/components/shellservertoolconfig.mdx @@ -9,5 +9,5 @@ Configuration for the openrouter:shell server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.ShellServerToolEngine](../../models/components/shellservertoolengine.mdx) | :heavy_minus_sign: | Which shell engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) keeps the provider's native hosted shell when available (OpenAI); on other providers the call is routed to the OpenRouter sandbox. | openrouter | -| `Environment` | [*components.ShellServerToolEnvironment](../../models/components/shellservertoolenvironment.mdx) | :heavy_minus_sign: | Server-side execution environment for the shell tool. Only container-backed environments are supported; "local" shells are not. | \{
"type": "container_auto"
} | \ No newline at end of file +| `Engine` | [*components.ShellServerToolEngine](../../models/components/shellservertoolengine.mdx) | ➖ | Which shell engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) keeps the provider's native hosted shell when available (OpenAI); on other providers the call is routed to the OpenRouter sandbox. | openrouter | +| `Environment` | [*components.ShellServerToolEnvironment](../../models/components/shellservertoolenvironment.mdx) | ➖ | Server-side execution environment for the shell tool. Only container-backed environments are supported; "local" shells are not. | \{
"type": "container_auto"
} | \ No newline at end of file diff --git a/docs/models/components/shellservertoolopenrouter.mdx b/docs/models/components/shellservertoolopenrouter.mdx index 33674ea7a..d620c11b5 100644 --- a/docs/models/components/shellservertoolopenrouter.mdx +++ b/docs/models/components/shellservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: runs shell commands server-side in a sandboxed | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ShellServerToolConfig](../../models/components/shellservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | -| `Type` | [components.ShellServerToolOpenRouterType](../../models/components/shellservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.ShellServerToolConfig](../../models/components/shellservertoolconfig.mdx) | ➖ | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | +| `Type` | [components.ShellServerToolOpenRouterType](../../models/components/shellservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/signinterndaemonrequest.mdx b/docs/models/components/signinterndaemonrequest.mdx index 2626f282a..645a2870e 100644 --- a/docs/models/components/signinterndaemonrequest.mdx +++ b/docs/models/components/signinterndaemonrequest.mdx @@ -6,4 +6,4 @@ title: "SignInternDaemonRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `BodySha256` | `string` | :heavy_check_mark: | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | \ No newline at end of file +| `BodySha256` | `string` | ✅ | Lower-case hex SHA-256 of the exact bytes the CLI will send as the daemon request body. | e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 | \ No newline at end of file diff --git a/docs/models/components/signinterndaemonresponse.mdx b/docs/models/components/signinterndaemonresponse.mdx index 235af92d3..64bbc1256 100644 --- a/docs/models/components/signinterndaemonresponse.mdx +++ b/docs/models/components/signinterndaemonresponse.mdx @@ -9,6 +9,6 @@ Headers the CLI copies onto the daemon request so the sidecar can verify who is | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `XOriInvokeSignature` | `string` | :heavy_check_mark: | Base64 Ed25519 signature over the intern id, timestamp, user and body digest. | -| `XOriInvokeTimestamp` | `string` | :heavy_check_mark: | Unix seconds at signing; the daemon refuses proofs older than its window. | -| `XOriInvokeUser` | `string` | :heavy_check_mark: | The verified OAuth subject the proof names. Never taken from the request. | \ No newline at end of file +| `XOriInvokeSignature` | `string` | ✅ | Base64 Ed25519 signature over the intern id, timestamp, user and body digest. | +| `XOriInvokeTimestamp` | `string` | ✅ | Unix seconds at signing; the daemon refuses proofs older than its window. | +| `XOriInvokeUser` | `string` | ✅ | The verified OAuth subject the proof names. Never taken from the request. | \ No newline at end of file diff --git a/docs/models/components/sourcecontent.mdx b/docs/models/components/sourcecontent.mdx index d471d9606..80e60771e 100644 --- a/docs/models/components/sourcecontent.mdx +++ b/docs/models/components/sourcecontent.mdx @@ -6,5 +6,5 @@ title: "SourceContent" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicDocumentBlockParamContent2](../../models/components/anthropicdocumentblockparamcontent2.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.SourceType](../../models/components/sourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [components.AnthropicDocumentBlockParamContent2](../../models/components/anthropicdocumentblockparamcontent2.mdx) | ✅ | N/A | +| `Type` | [components.SourceType](../../models/components/sourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/speechinputreferenceaudio.mdx b/docs/models/components/speechinputreferenceaudio.mdx index c2bbb82ba..ddd8625bc 100644 --- a/docs/models/components/speechinputreferenceaudio.mdx +++ b/docs/models/components/speechinputreferenceaudio.mdx @@ -9,5 +9,5 @@ Reference audio input for stateless voice cloning. Up to three parts per request | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `InputAudio` | [components.SpeechInputReferenceAudioInput](../../models/components/speechinputreferenceaudioinput.mdx) | :heavy_check_mark: | Reference audio input object | -| `Type` | [components.SpeechInputReferenceAudioType](../../models/components/speechinputreferenceaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `InputAudio` | [components.SpeechInputReferenceAudioInput](../../models/components/speechinputreferenceaudioinput.mdx) | ✅ | Reference audio input object | +| `Type` | [components.SpeechInputReferenceAudioType](../../models/components/speechinputreferenceaudiotype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/speechinputreferenceaudioinput.mdx b/docs/models/components/speechinputreferenceaudioinput.mdx index 1dcc1498a..8ebc57809 100644 --- a/docs/models/components/speechinputreferenceaudioinput.mdx +++ b/docs/models/components/speechinputreferenceaudioinput.mdx @@ -9,6 +9,6 @@ Reference audio input object | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | `*string` | :heavy_minus_sign: | Base64-encoded reference audio (optionally a data URI). Supported audio formats are provider-specific. Limited to 20 MiB of base64 (15 MiB of decoded audio). Exactly one of `data` or `url` is required. | data:audio/wav;base64,UklGRuQXDABXQVZF... | -| `Format` | `*string` | :heavy_minus_sign: | Audio format of the reference audio (e.g., wav, mp3). Optional; most providers detect the format from the audio bytes. | wav | -| `URL` | `*string` | :heavy_minus_sign: | Public http(s) URL of the reference audio. OpenRouter downloads it (15 MiB max) and forwards the bytes, never the URL. Exactly one of `data` or `url` is required. | https://example.com/reference.wav | \ No newline at end of file +| `Data` | `*string` | ➖ | Base64-encoded reference audio (optionally a data URI). Supported audio formats are provider-specific. Limited to 20 MiB of base64 (15 MiB of decoded audio). Exactly one of `data` or `url` is required. | data:audio/wav;base64,UklGRuQXDABXQVZF... | +| `Format` | `*string` | ➖ | Audio format of the reference audio (e.g., wav, mp3). Optional; most providers detect the format from the audio bytes. | wav | +| `URL` | `*string` | ➖ | Public http(s) URL of the reference audio. OpenRouter downloads it (15 MiB max) and forwards the bytes, never the URL. Exactly one of `data` or `url` is required. | https://example.com/reference.wav | \ No newline at end of file diff --git a/docs/models/components/speechinputreferenceimage.mdx b/docs/models/components/speechinputreferenceimage.mdx index a50429cdf..ed47ce012 100644 --- a/docs/models/components/speechinputreferenceimage.mdx +++ b/docs/models/components/speechinputreferenceimage.mdx @@ -9,5 +9,5 @@ Reference image describing the desired voice. Cannot be combined with `input_aud | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.SpeechInputReferenceImageInput](../../models/components/speechinputreferenceimageinput.mdx) | :heavy_check_mark: | Reference image input object | -| `Type` | [components.SpeechInputReferenceImageType](../../models/components/speechinputreferenceimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.SpeechInputReferenceImageInput](../../models/components/speechinputreferenceimageinput.mdx) | ✅ | Reference image input object | +| `Type` | [components.SpeechInputReferenceImageType](../../models/components/speechinputreferenceimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/speechinputreferenceimageinput.mdx b/docs/models/components/speechinputreferenceimageinput.mdx index 5af0f2d24..e7e550874 100644 --- a/docs/models/components/speechinputreferenceimageinput.mdx +++ b/docs/models/components/speechinputreferenceimageinput.mdx @@ -9,4 +9,4 @@ Reference image input object | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `URL` | `string` | :heavy_check_mark: | JPEG, PNG, or WebP reference image as a base64 data URI or a public http(s) URL. Remote images are downloaded (15 MiB max) and forwarded as bytes, never as the URL. | data:image/png;base64,iVBORw0KGgo... | \ No newline at end of file +| `URL` | `string` | ✅ | JPEG, PNG, or WebP reference image as a base64 data URI or a public http(s) URL. Remote images are downloaded (15 MiB max) and forwarded as bytes, never as the URL. | data:image/png;base64,iVBORw0KGgo... | \ No newline at end of file diff --git a/docs/models/components/speechinputreferencetext.mdx b/docs/models/components/speechinputreferencetext.mdx index c8ab60319..f720dff74 100644 --- a/docs/models/components/speechinputreferencetext.mdx +++ b/docs/models/components/speechinputreferencetext.mdx @@ -9,5 +9,5 @@ Transcript of an `input_audio` part | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Text` | `string` | :heavy_check_mark: | Transcript of an `input_audio` part. With a single clip it may appear before or after the clip; with multiple clips it must immediately follow the clip it transcribes. | I used to rule the world. | -| `Type` | [components.SpeechInputReferenceTextType](../../models/components/speechinputreferencetexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Text` | `string` | ✅ | Transcript of an `input_audio` part. With a single clip it may appear before or after the clip; with multiple clips it must immediately follow the clip it transcribes. | I used to rule the world. | +| `Type` | [components.SpeechInputReferenceTextType](../../models/components/speechinputreferencetexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/speechrequest.mdx b/docs/models/components/speechrequest.mdx index 70bcfd002..464621247 100644 --- a/docs/models/components/speechrequest.mdx +++ b/docs/models/components/speechrequest.mdx @@ -9,14 +9,14 @@ Text-to-speech request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Input` | [components.SpeechInput](../../models/components/speechinput.mdx) | :heavy_check_mark: | Text to synthesize, or a list of turns for multi-speaker input. Each turn has its own text, voice, and instructions. Multi-speaker input is currently supported by Gemini TTS models only. | Hello world | -| `InputReferences` | [][components.SpeechInputReference](../../models/components/speechinputreference.mdx) | :heavy_minus_sign: | Reference content for stateless voice cloning or voice design. Audio mode: one to three `input_audio` parts, each optionally paired with a `text` part carrying its transcript (a single clip accepts its transcript before or after it; with multiple clips each transcript immediately follows its clip); only routed to endpoints that support voice cloning (and multiple references when more than one part is sent). Image mode: exactly one `image_url` part; only routed to endpoints that support image references. The two modes cannot be mixed. An empty array is treated as no reference. | [
\{
"input_audio": \{
"data": "data:audio/wav;base64,UklGRuQXDABXQVZF..."
},
"type": "input_audio"
},
\{
"text": "I used to rule the world.",
"type": "text"
}
] | -| `Instructions` | `*string` | :heavy_minus_sign: | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts and Gemini TTS models. Ignored by other providers. | Speak in a warm and friendly tone. | -| `Model` | `string` | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `Provider` | [*components.SpeechRequestProvider](../../models/components/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `ResponseFormat` | [*components.SpeechRequestResponseFormat](../../models/components/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Speed` | `*float64` | :heavy_minus_sign: | Playback speed multiplier. Honored by models that support it (e.g. OpenAI TTS). Other providers either ignore it or return a 400 for a non-default value when the model has no speed control. | 1 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | -| `Voice` | `*string` | :heavy_minus_sign: | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file +| `Input` | [components.SpeechInput](../../models/components/speechinput.mdx) | ✅ | Text to synthesize, or a list of turns for multi-speaker input. Each turn has its own text, voice, and instructions. Multi-speaker input is currently supported by Gemini TTS models only. | Hello world | +| `InputReferences` | [][components.SpeechInputReference](../../models/components/speechinputreference.mdx) | ➖ | Reference content for stateless voice cloning or voice design. Audio mode: one to three `input_audio` parts, each optionally paired with a `text` part carrying its transcript (a single clip accepts its transcript before or after it; with multiple clips each transcript immediately follows its clip); only routed to endpoints that support voice cloning (and multiple references when more than one part is sent). Image mode: exactly one `image_url` part; only routed to endpoints that support image references. The two modes cannot be mixed. An empty array is treated as no reference. | [
\{
"input_audio": \{
"data": "data:audio/wav;base64,UklGRuQXDABXQVZF..."
},
"type": "input_audio"
},
\{
"text": "I used to rule the world.",
"type": "text"
}
] | +| `Instructions` | `*string` | ➖ | Delivery instructions for the whole request, such as tone, pacing, or emotion. Supported by OpenAI gpt-4o-mini-tts and Gemini TTS models. Ignored by other providers. | Speak in a warm and friendly tone. | +| `Model` | `string` | ✅ | TTS model identifier | mistralai/voxtral-mini-tts-2603 | +| `Provider` | [*components.SpeechRequestProvider](../../models/components/speechrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `ResponseFormat` | [*components.SpeechRequestResponseFormat](../../models/components/speechrequestresponseformat.mdx) | ➖ | Audio output format | pcm | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Speed` | `*float64` | ➖ | Playback speed multiplier. Honored by models that support it (e.g. OpenAI TTS). Other providers either ignore it or return a 400 for a non-default value when the model has no speed control. | 1 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | +| `Voice` | `*string` | ➖ | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file diff --git a/docs/models/components/speechrequestprovider.mdx b/docs/models/components/speechrequestprovider.mdx index 23f0bc0c4..b7d5321b2 100644 --- a/docs/models/components/speechrequestprovider.mdx +++ b/docs/models/components/speechrequestprovider.mdx @@ -9,6 +9,6 @@ Provider configuration: data policy routing preferences (`zdr`, `data_collection | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DataCollection` | optionalnullable.OptionalNullable[[components.SpeechRequestDataCollection](../../models/components/speechrequestdatacollection.mdx)] | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `Zdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `DataCollection` | optionalnullable.OptionalNullable[[components.SpeechRequestDataCollection](../../models/components/speechrequestdatacollection.mdx)] | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `Zdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/components/speechturn.mdx b/docs/models/components/speechturn.mdx index f2ef10bb6..80204ed1f 100644 --- a/docs/models/components/speechturn.mdx +++ b/docs/models/components/speechturn.mdx @@ -6,6 +6,6 @@ title: "SpeechTurn" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Instructions` | `*string` | :heavy_minus_sign: | Delivery instructions for this turn, such as tone, pacing, or emotion. Overrides the top-level `instructions`. | whispering | -| `Text` | `string` | :heavy_check_mark: | Text to synthesize | Hi Jane. | -| `Voice` | `*string` | :heavy_minus_sign: | Voice for this turn. Defaults to the top-level `voice`. | Kore | \ No newline at end of file +| `Instructions` | `*string` | ➖ | Delivery instructions for this turn, such as tone, pacing, or emotion. Overrides the top-level `instructions`. | whispering | +| `Text` | `string` | ✅ | Text to synthesize | Hi Jane. | +| `Voice` | `*string` | ➖ | Voice for this turn. Defaults to the top-level `voice`. | Kore | \ No newline at end of file diff --git a/docs/models/components/stance.mdx b/docs/models/components/stance.mdx index daa1bc601..676f0db01 100644 --- a/docs/models/components/stance.mdx +++ b/docs/models/components/stance.mdx @@ -6,5 +6,5 @@ title: "Stance" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Stance` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Model` | `string` | ✅ | N/A | +| `Stance` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenfinishreasonis.mdx b/docs/models/components/stopservertoolswhenfinishreasonis.mdx index 303e057b0..7ad622e15 100644 --- a/docs/models/components/stopservertoolswhenfinishreasonis.mdx +++ b/docs/models/components/stopservertoolswhenfinishreasonis.mdx @@ -9,5 +9,5 @@ Stop when the upstream model emits this finish reason (e.g. `length`). | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Reason` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenFinishReasonIsType](../../models/components/stopservertoolswhenfinishreasonistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Reason` | `string` | ✅ | N/A | +| `Type` | [components.StopServerToolsWhenFinishReasonIsType](../../models/components/stopservertoolswhenfinishreasonistype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenhastoolcall.mdx b/docs/models/components/stopservertoolswhenhastoolcall.mdx index 54c1d4096..0c0647002 100644 --- a/docs/models/components/stopservertoolswhenhastoolcall.mdx +++ b/docs/models/components/stopservertoolswhenhastoolcall.mdx @@ -9,5 +9,5 @@ Stop after a tool with this name has been called. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ToolName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenHasToolCallType](../../models/components/stopservertoolswhenhastoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ToolName` | `string` | ✅ | N/A | +| `Type` | [components.StopServerToolsWhenHasToolCallType](../../models/components/stopservertoolswhenhastoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenmaxcost.mdx b/docs/models/components/stopservertoolswhenmaxcost.mdx index addcbca5e..b0d033e24 100644 --- a/docs/models/components/stopservertoolswhenmaxcost.mdx +++ b/docs/models/components/stopservertoolswhenmaxcost.mdx @@ -9,5 +9,5 @@ Stop once cumulative cost across the loop exceeds this dollar threshold. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `MaxCostInDollars` | `float64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenMaxCostType](../../models/components/stopservertoolswhenmaxcosttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `MaxCostInDollars` | `float64` | ✅ | N/A | +| `Type` | [components.StopServerToolsWhenMaxCostType](../../models/components/stopservertoolswhenmaxcosttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenmaxtokensused.mdx b/docs/models/components/stopservertoolswhenmaxtokensused.mdx index c229dcbef..bdc5b9cfe 100644 --- a/docs/models/components/stopservertoolswhenmaxtokensused.mdx +++ b/docs/models/components/stopservertoolswhenmaxtokensused.mdx @@ -9,5 +9,5 @@ Stop once cumulative token usage across the loop exceeds this threshold. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `MaxTokens` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenMaxTokensUsedType](../../models/components/stopservertoolswhenmaxtokensusedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `MaxTokens` | `int64` | ✅ | N/A | +| `Type` | [components.StopServerToolsWhenMaxTokensUsedType](../../models/components/stopservertoolswhenmaxtokensusedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenstepcountis.mdx b/docs/models/components/stopservertoolswhenstepcountis.mdx index 4c7ca7c2b..d14252fc2 100644 --- a/docs/models/components/stopservertoolswhenstepcountis.mdx +++ b/docs/models/components/stopservertoolswhenstepcountis.mdx @@ -9,5 +9,5 @@ Stop after the agent loop has executed this many steps. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `StepCount` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenStepCountIsType](../../models/components/stopservertoolswhenstepcountistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `StepCount` | `int64` | ✅ | N/A | +| `Type` | [components.StopServerToolsWhenStepCountIsType](../../models/components/stopservertoolswhenstepcountistype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/storedprompttemplate.mdx b/docs/models/components/storedprompttemplate.mdx index 9a13ae6cd..f184cc301 100644 --- a/docs/models/components/storedprompttemplate.mdx +++ b/docs/models/components/storedprompttemplate.mdx @@ -6,5 +6,5 @@ title: "StoredPromptTemplate" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Variables` | optionalnullable.OptionalNullable[map[string][components.Variables](../../models/components/variables.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | +| `Variables` | optionalnullable.OptionalNullable[map[string][components.Variables](../../models/components/variables.mdx)] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/streameventsresponsecompleted.mdx b/docs/models/components/streameventsresponsecompleted.mdx index 954b61fb2..4bf269abc 100644 --- a/docs/models/components/streameventsresponsecompleted.mdx +++ b/docs/models/components/streameventsresponsecompleted.mdx @@ -9,6 +9,6 @@ Event emitted when a response has completed successfully | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseCompletedType](../../models/components/streameventsresponsecompletedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.StreamEventsResponseCompletedType](../../models/components/streameventsresponsecompletedtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponsefailed.mdx b/docs/models/components/streameventsresponsefailed.mdx index bcc56b0dc..852bb5e5c 100644 --- a/docs/models/components/streameventsresponsefailed.mdx +++ b/docs/models/components/streameventsresponsefailed.mdx @@ -9,6 +9,6 @@ Event emitted when a response has failed | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseFailedType](../../models/components/streameventsresponsefailedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.StreamEventsResponseFailedType](../../models/components/streameventsresponsefailedtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseincomplete.mdx b/docs/models/components/streameventsresponseincomplete.mdx index 5f90aadd1..e6c3b3901 100644 --- a/docs/models/components/streameventsresponseincomplete.mdx +++ b/docs/models/components/streameventsresponseincomplete.mdx @@ -9,6 +9,6 @@ Event emitted when a response is incomplete | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseIncompleteType](../../models/components/streameventsresponseincompletetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.StreamEventsResponseIncompleteType](../../models/components/streameventsresponseincompletetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseoutputitemadded.mdx b/docs/models/components/streameventsresponseoutputitemadded.mdx index 17f170a7e..6357d74a5 100644 --- a/docs/models/components/streameventsresponseoutputitemadded.mdx +++ b/docs/models/components/streameventsresponseoutputitemadded.mdx @@ -9,7 +9,7 @@ Event emitted when a new output item is added to the response | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | :heavy_check_mark: | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseOutputItemAddedType](../../models/components/streameventsresponseoutputitemaddedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | ✅ | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | +| `OutputIndex` | `int64` | ✅ | N/A | | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.StreamEventsResponseOutputItemAddedType](../../models/components/streameventsresponseoutputitemaddedtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseoutputitemdone.mdx b/docs/models/components/streameventsresponseoutputitemdone.mdx index 78dd4200f..6d1600574 100644 --- a/docs/models/components/streameventsresponseoutputitemdone.mdx +++ b/docs/models/components/streameventsresponseoutputitemdone.mdx @@ -9,7 +9,7 @@ Event emitted when an output item is complete | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | :heavy_check_mark: | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseOutputItemDoneType](../../models/components/streameventsresponseoutputitemdonetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | ✅ | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | +| `OutputIndex` | `int64` | ✅ | N/A | | +| `SequenceNumber` | `int64` | ✅ | N/A | | +| `Type` | [components.StreamEventsResponseOutputItemDoneType](../../models/components/streameventsresponseoutputitemdonetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/streamlogprob.mdx b/docs/models/components/streamlogprob.mdx index 4868841c9..1a8ee5a6b 100644 --- a/docs/models/components/streamlogprob.mdx +++ b/docs/models/components/streamlogprob.mdx @@ -9,7 +9,7 @@ Log probability information for a token | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | :heavy_minus_sign: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | -| `TopLogprobs` | [][components.StreamLogprobTopLogprob](../../models/components/streamlogprobtoplogprob.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ➖ | N/A | +| `Logprob` | `float64` | ✅ | N/A | +| `Token` | `string` | ✅ | N/A | +| `TopLogprobs` | [][components.StreamLogprobTopLogprob](../../models/components/streamlogprobtoplogprob.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/streamlogprobtoplogprob.mdx b/docs/models/components/streamlogprobtoplogprob.mdx index d0098a430..99943e74c 100644 --- a/docs/models/components/streamlogprobtoplogprob.mdx +++ b/docs/models/components/streamlogprobtoplogprob.mdx @@ -9,6 +9,6 @@ Alternative token with its log probability | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | :heavy_minus_sign: | N/A | -| `Logprob` | `*float64` | :heavy_minus_sign: | N/A | -| `Token` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Bytes` | []`int64` | ➖ | N/A | +| `Logprob` | `*float64` | ➖ | N/A | +| `Token` | `*string` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/stt.mdx b/docs/models/components/stt.mdx index 19d7f7524..a96a0a8b6 100644 --- a/docs/models/components/stt.mdx +++ b/docs/models/components/stt.mdx @@ -6,6 +6,6 @@ title: "STT" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/sttentity.mdx b/docs/models/components/sttentity.mdx index 3b5fa9e3a..206962551 100644 --- a/docs/models/components/sttentity.mdx +++ b/docs/models/components/sttentity.mdx @@ -9,7 +9,7 @@ A detected entity, returned when the provider runs entity detection | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `EndChar` | `int64` | :heavy_check_mark: | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | -| `StartChar` | `int64` | :heavy_check_mark: | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | -| `Text` | `string` | :heavy_check_mark: | Entity text as it appears in the transcript | | -| `Type` | `string` | :heavy_check_mark: | Provider entity type label | name | \ No newline at end of file +| `EndChar` | `int64` | ✅ | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | +| `StartChar` | `int64` | ✅ | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | +| `Text` | `string` | ✅ | Entity text as it appears in the transcript | | +| `Type` | `string` | ✅ | Provider entity type label | name | \ No newline at end of file diff --git a/docs/models/components/sttinlineinputaudio.mdx b/docs/models/components/sttinlineinputaudio.mdx index 900fddb90..f48fe33d9 100644 --- a/docs/models/components/sttinlineinputaudio.mdx +++ b/docs/models/components/sttinlineinputaudio.mdx @@ -9,5 +9,5 @@ Inline base64 audio input for speech-to-text | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | Base64-encoded audio data (raw bytes, not a data URI) | -| `Format` | `string` | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. "pcm" means headerless signed 16-bit little-endian mono audio at 16 kHz. | \ No newline at end of file +| `Data` | `string` | ✅ | Base64-encoded audio data (raw bytes, not a data URI) | +| `Format` | `string` | ✅ | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. "pcm" means headerless signed 16-bit little-endian mono audio at 16 kHz. | \ No newline at end of file diff --git a/docs/models/components/sttrequest.mdx b/docs/models/components/sttrequest.mdx index 3989cdd98..27c49313f 100644 --- a/docs/models/components/sttrequest.mdx +++ b/docs/models/components/sttrequest.mdx @@ -9,15 +9,15 @@ Speech-to-text request input. Accepts a JSON body with input_audio containing ba | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Diarize` | `*bool` | :heavy_minus_sign: | Label each word with the speaker who said it. Speaker labels are returned on the words array (speaker, speaker_label), so response_format must be "verbose_json" (a "json" request is rejected with a 400) and word timestamps are included even when timestamp_granularities omits "word". Only supported by some providers; the request is rejected with a 400 when the selected model cannot diarize. Providers may charge extra. | true | -| `InputAudio` | [components.STTInputAudio](../../models/components/sttinputaudio.mdx) | :heavy_check_mark: | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | -| `Keyterms` | []`string` | :heavy_minus_sign: | Domain terms, names, or phrases to bias recognition toward. Only supported by some providers; the request is rejected with a 400 when the selected model cannot use keyterms. Providers may cap the number of terms or characters per term and may charge extra. | [
"OpenRouter",
"Scribe"
] | -| `Language` | `*string` | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `Model` | `string` | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | -| `Provider` | [*components.STTRequestProvider](../../models/components/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `ResponseFormat` | [*components.STTRequestResponseFormat](../../models/components/sttrequestresponseformat.mdx) | :heavy_minus_sign: | Output format. "json" (default) returns \{ text, usage }. "verbose_json" additionally returns task, language, duration, and segment-level timestamps; only supported by OpenAI-compatible providers. | json | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature for transcription | 0 | -| `TimestampGranularities` | [][components.STTTimestampGranularity](../../models/components/stttimestampgranularity.mdx) | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "segment" returns segment-level timestamps; "word" additionally returns word-level timestamps in the words array. Ignored unless response_format is "verbose_json". | [
"segment"
] | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `Diarize` | `*bool` | ➖ | Label each word with the speaker who said it. Speaker labels are returned on the words array (speaker, speaker_label), so response_format must be "verbose_json" (a "json" request is rejected with a 400) and word timestamps are included even when timestamp_granularities omits "word". Only supported by some providers; the request is rejected with a 400 when the selected model cannot diarize. Providers may charge extra. | true | +| `InputAudio` | [components.STTInputAudio](../../models/components/sttinputaudio.mdx) | ✅ | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | +| `Keyterms` | []`string` | ➖ | Domain terms, names, or phrases to bias recognition toward. Only supported by some providers; the request is rejected with a 400 when the selected model cannot use keyterms. Providers may cap the number of terms or characters per term and may charge extra. | [
"OpenRouter",
"Scribe"
] | +| `Language` | `*string` | ➖ | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | +| `Model` | `string` | ✅ | STT model identifier | openai/whisper-large-v3 | +| `Provider` | [*components.STTRequestProvider](../../models/components/sttrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `ResponseFormat` | [*components.STTRequestResponseFormat](../../models/components/sttrequestresponseformat.mdx) | ➖ | Output format. "json" (default) returns \{ text, usage }. "verbose_json" additionally returns task, language, duration, and segment-level timestamps; only supported by OpenAI-compatible providers. | json | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Temperature` | `*float64` | ➖ | Sampling temperature for transcription | 0 | +| `TimestampGranularities` | [][components.STTTimestampGranularity](../../models/components/stttimestampgranularity.mdx) | ➖ | Timestamp detail levels to include when response_format is "verbose_json". "segment" returns segment-level timestamps; "word" additionally returns word-level timestamps in the words array. Ignored unless response_format is "verbose_json". | [
"segment"
] | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/components/sttrequestprovider.mdx b/docs/models/components/sttrequestprovider.mdx index 6d5dd6175..ae51b3d99 100644 --- a/docs/models/components/sttrequestprovider.mdx +++ b/docs/models/components/sttrequestprovider.mdx @@ -9,6 +9,6 @@ Provider configuration: data policy routing preferences (`zdr`, `data_collection | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DataCollection` | optionalnullable.OptionalNullable[[components.STTRequestDataCollection](../../models/components/sttrequestdatacollection.mdx)] | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `Zdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `DataCollection` | optionalnullable.OptionalNullable[[components.STTRequestDataCollection](../../models/components/sttrequestdatacollection.mdx)] | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `Options` | [*components.ProviderOptions](../../models/components/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `Zdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/components/sttresponse.mdx b/docs/models/components/sttresponse.mdx index c91201a9d..84268e251 100644 --- a/docs/models/components/sttresponse.mdx +++ b/docs/models/components/sttresponse.mdx @@ -9,13 +9,13 @@ STT response containing transcribed text and optional usage statistics | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Confidence` | `*float64` | :heavy_minus_sign: | Provider confidence for the whole transcript from 0 to 1, present when response_format is verbose_json and the provider scores the full transcript | 0.94 | -| `Duration` | `*float64` | :heavy_minus_sign: | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | -| `Entities` | [][components.STTEntity](../../models/components/sttentity.mdx) | :heavy_minus_sign: | Detected entities with character offsets into text, present when the provider runs entity detection | | -| `Language` | `*string` | :heavy_minus_sign: | Detected or forced language, present when response_format is verbose_json | english | -| `LanguageConfidence` | `*float64` | :heavy_minus_sign: | Provider confidence in the detected language from 0 to 1, present when response_format is verbose_json and the provider scores language detection | 0.98 | -| `Segments` | [][components.STTSegment](../../models/components/sttsegment.mdx) | :heavy_minus_sign: | Timestamped transcript segments, present when response_format is verbose_json | | -| `Task` | `*string` | :heavy_minus_sign: | The task performed, present when response_format is verbose_json | transcribe | -| `Text` | `string` | :heavy_check_mark: | The transcribed text | Hello, this is a test of OpenAI speech-to-text transcription. The weather is sunny today and the temperature is around 72 degrees. | -| `Usage` | [*components.STTUsage](../../models/components/sttusage.mdx) | :heavy_minus_sign: | Aggregated usage statistics for the request | \{
"cost": 0.000508,
"input_tokens": 83,
"output_tokens": 30,
"seconds": 9.2,
"total_tokens": 113
} | -| `Words` | [][components.STTWord](../../models/components/sttword.mdx) | :heavy_minus_sign: | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file +| `Confidence` | `*float64` | ➖ | Provider confidence for the whole transcript from 0 to 1, present when response_format is verbose_json and the provider scores the full transcript | 0.94 | +| `Duration` | `*float64` | ➖ | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | +| `Entities` | [][components.STTEntity](../../models/components/sttentity.mdx) | ➖ | Detected entities with character offsets into text, present when the provider runs entity detection | | +| `Language` | `*string` | ➖ | Detected or forced language, present when response_format is verbose_json | english | +| `LanguageConfidence` | `*float64` | ➖ | Provider confidence in the detected language from 0 to 1, present when response_format is verbose_json and the provider scores language detection | 0.98 | +| `Segments` | [][components.STTSegment](../../models/components/sttsegment.mdx) | ➖ | Timestamped transcript segments, present when response_format is verbose_json | | +| `Task` | `*string` | ➖ | The task performed, present when response_format is verbose_json | transcribe | +| `Text` | `string` | ✅ | The transcribed text | Hello, this is a test of OpenAI speech-to-text transcription. The weather is sunny today and the temperature is around 72 degrees. | +| `Usage` | [*components.STTUsage](../../models/components/sttusage.mdx) | ➖ | Aggregated usage statistics for the request | \{
"cost": 0.000508,
"input_tokens": 83,
"output_tokens": 30,
"seconds": 9.2,
"total_tokens": 113
} | +| `Words` | [][components.STTWord](../../models/components/sttword.mdx) | ➖ | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file diff --git a/docs/models/components/sttsegment.mdx b/docs/models/components/sttsegment.mdx index 5f3748e3d..e307f7034 100644 --- a/docs/models/components/sttsegment.mdx +++ b/docs/models/components/sttsegment.mdx @@ -9,16 +9,16 @@ A timestamped transcript segment, returned when response_format is verbose_json | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `AvgLogprob` | `*float64` | :heavy_minus_sign: | Average log probability of the segment | | -| `Channel` | `*int64` | :heavy_minus_sign: | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | -| `CompressionRatio` | `*float64` | :heavy_minus_sign: | Compression ratio of the segment | | -| `End` | `float64` | :heavy_check_mark: | Segment end time in seconds | 3.2 | -| `ID` | `int64` | :heavy_check_mark: | Segment index within the transcript | 0 | -| `NoSpeechProb` | `*float64` | :heavy_minus_sign: | Probability the segment contains no speech | | -| `Seek` | `*int64` | :heavy_minus_sign: | Seek offset of the segment | 0 | -| `Speaker` | `*int64` | :heavy_minus_sign: | Speaker index for the segment, present when the provider returns diarization data | 0 | -| `SpeakerLabel` | `*string` | :heavy_minus_sign: | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | -| `Start` | `float64` | :heavy_check_mark: | Segment start time in seconds | 0 | -| `Temperature` | `*float64` | :heavy_minus_sign: | Temperature used for the segment | | -| `Text` | `string` | :heavy_check_mark: | Transcribed text of the segment | Hello there. | -| `Tokens` | []`int64` | :heavy_minus_sign: | Token IDs of the segment | | \ No newline at end of file +| `AvgLogprob` | `*float64` | ➖ | Average log probability of the segment | | +| `Channel` | `*int64` | ➖ | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | +| `CompressionRatio` | `*float64` | ➖ | Compression ratio of the segment | | +| `End` | `float64` | ✅ | Segment end time in seconds | 3.2 | +| `ID` | `int64` | ✅ | Segment index within the transcript | 0 | +| `NoSpeechProb` | `*float64` | ➖ | Probability the segment contains no speech | | +| `Seek` | `*int64` | ➖ | Seek offset of the segment | 0 | +| `Speaker` | `*int64` | ➖ | Speaker index for the segment, present when the provider returns diarization data | 0 | +| `SpeakerLabel` | `*string` | ➖ | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | +| `Start` | `float64` | ✅ | Segment start time in seconds | 0 | +| `Temperature` | `*float64` | ➖ | Temperature used for the segment | | +| `Text` | `string` | ✅ | Transcribed text of the segment | Hello there. | +| `Tokens` | []`int64` | ➖ | Token IDs of the segment | | \ No newline at end of file diff --git a/docs/models/components/stturlinputaudio.mdx b/docs/models/components/stturlinputaudio.mdx index 97d6c70d6..c5069ec63 100644 --- a/docs/models/components/stturlinputaudio.mdx +++ b/docs/models/components/stturlinputaudio.mdx @@ -9,5 +9,5 @@ Audio input fetched by the provider from a URL | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Format` | `*string` | :heavy_minus_sign: | Audio format of the file at the URL. Defaults to the extension of the URL path; required when the path has no extension. | -| `URL` | `string` | :heavy_check_mark: | Publicly reachable http(s) URL of the audio file. The provider downloads it directly, so the inline upload size limit does not apply. Only supported by some providers. | \ No newline at end of file +| `Format` | `*string` | ➖ | Audio format of the file at the URL. Defaults to the extension of the URL path; required when the path has no extension. | +| `URL` | `string` | ✅ | Publicly reachable http(s) URL of the audio file. The provider downloads it directly, so the inline upload size limit does not apply. Only supported by some providers. | \ No newline at end of file diff --git a/docs/models/components/sttusage.mdx b/docs/models/components/sttusage.mdx index 23197551f..5aa829a2d 100644 --- a/docs/models/components/sttusage.mdx +++ b/docs/models/components/sttusage.mdx @@ -9,8 +9,8 @@ Aggregated usage statistics for the request | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `Cost` | `*float64` | :heavy_minus_sign: | Total cost of the request in USD | 0.000508 | -| `InputTokens` | `*int64` | :heavy_minus_sign: | Number of input tokens billed for this request | 83 | -| `OutputTokens` | `*int64` | :heavy_minus_sign: | Number of output tokens generated | 30 | -| `Seconds` | `*float64` | :heavy_minus_sign: | Duration of the input audio in seconds | 9.2 | -| `TotalTokens` | `*int64` | :heavy_minus_sign: | Total number of tokens used (input + output) | 113 | \ No newline at end of file +| `Cost` | `*float64` | ➖ | Total cost of the request in USD | 0.000508 | +| `InputTokens` | `*int64` | ➖ | Number of input tokens billed for this request | 83 | +| `OutputTokens` | `*int64` | ➖ | Number of output tokens generated | 30 | +| `Seconds` | `*float64` | ➖ | Duration of the input audio in seconds | 9.2 | +| `TotalTokens` | `*int64` | ➖ | Total number of tokens used (input + output) | 113 | \ No newline at end of file diff --git a/docs/models/components/sttword.mdx b/docs/models/components/sttword.mdx index e482d6427..8603951d2 100644 --- a/docs/models/components/sttword.mdx +++ b/docs/models/components/sttword.mdx @@ -9,11 +9,11 @@ A timestamped word, returned when the provider includes word-level timestamps | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Channel` | `*int64` | :heavy_minus_sign: | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | -| `Confidence` | `*float64` | :heavy_minus_sign: | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | -| `End` | `float64` | :heavy_check_mark: | Word end time in seconds | 0.4 | -| `Speaker` | `*int64` | :heavy_minus_sign: | Speaker index for the word, present when the provider returns diarization data | 0 | -| `SpeakerLabel` | `*string` | :heavy_minus_sign: | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | -| `Start` | `float64` | :heavy_check_mark: | Word start time in seconds | 0 | -| `Type` | [*components.STTWordType](../../models/components/sttwordtype.mdx) | :heavy_minus_sign: | Kind of entry; omitted or "word" for spoken words, "audio_event" for non-speech sounds the provider tags with timestamps | word | -| `Word` | `string` | :heavy_check_mark: | The transcribed word, or the event tag such as "(laughter)" when type is audio_event | Hello | \ No newline at end of file +| `Channel` | `*int64` | ➖ | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | +| `Confidence` | `*float64` | ➖ | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | +| `End` | `float64` | ✅ | Word end time in seconds | 0.4 | +| `Speaker` | `*int64` | ➖ | Speaker index for the word, present when the provider returns diarization data | 0 | +| `SpeakerLabel` | `*string` | ➖ | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | +| `Start` | `float64` | ✅ | Word start time in seconds | 0 | +| `Type` | [*components.STTWordType](../../models/components/sttwordtype.mdx) | ➖ | Kind of entry; omitted or "word" for spoken words, "audio_event" for non-speech sounds the provider tags with timestamps | word | +| `Word` | `string` | ✅ | The transcribed word, or the event tag such as "(laughter)" when type is audio_event | Hello | \ No newline at end of file diff --git a/docs/models/components/subagentnestedtool.mdx b/docs/models/components/subagentnestedtool.mdx index e11bb182c..a7c849a56 100644 --- a/docs/models/components/subagentnestedtool.mdx +++ b/docs/models/components/subagentnestedtool.mdx @@ -9,6 +9,6 @@ A tool made available to the subagent. Only OpenRouter server tools (e.g. openro | Field | Type | Required | Description | Example | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `Parameters` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `Type` | `string` | :heavy_check_mark: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file +| `Parameters` | map[string]`any` | ➖ | N/A | | +| `Type` | `string` | ✅ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file diff --git a/docs/models/components/subagentreasoning.mdx b/docs/models/components/subagentreasoning.mdx index a05864f16..4fc27b0f8 100644 --- a/docs/models/components/subagentreasoning.mdx +++ b/docs/models/components/subagentreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the subagent call. Use this to control reas | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Effort` | [*components.SubagentReasoningEffort](../../models/components/subagentreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | -| `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens the subagent may use. Forwarded to the subagent call as `reasoning.max_tokens`. | \ No newline at end of file +| `Effort` | [*components.SubagentReasoningEffort](../../models/components/subagentreasoningeffort.mdx) | ➖ | Reasoning effort level for the subagent call. | +| `MaxTokens` | `*int64` | ➖ | Maximum number of reasoning tokens the subagent may use. Forwarded to the subagent call as `reasoning.max_tokens`. | \ No newline at end of file diff --git a/docs/models/components/subagentservertoolconfig.mdx b/docs/models/components/subagentservertoolconfig.mdx index 0f245741f..448b17f34 100644 --- a/docs/models/components/subagentservertoolconfig.mdx +++ b/docs/models/components/subagentservertoolconfig.mdx @@ -9,13 +9,13 @@ Configuration for one openrouter:subagent server tool entry. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `InheritFunctions` | `*bool` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. When true, the subagent inherits every client function defined in the request's top-level `tools` list. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | true | -| `InheritedFunctionNames` | []`string` | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. Names of the top-level function tools that the subagent will inherit. Any tool that matches by name will be copied fully into the tools array of the subagent. When `inherit_functions` is `true`, this list does nothing, because every client function will be inherited by default. Names are trimmed before validation, so a whitespace-only name is rejected with a `400`. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | [
"lookup_order"
] | -| `Instructions` | `*string` | :heavy_minus_sign: | System instructions for the subagent. When omitted, the subagent responds with no system prompt of its own. | You are a fast, focused worker. Complete the task exactly as described. | -| `MaxCompletionTokens` | `*int64` | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | -| `MaxToolCalls` | `*int64` | :heavy_minus_sign: | Maximum number of tool-calling steps the subagent may take during its agentic loop. Capped at 25. Only relevant when the subagent is given tools. Forwarded to the subagent call as `max_tool_calls`. | 5 | -| `Model` | `*string` | :heavy_minus_sign: | Slug of the model that executes delegated tasks (any OpenRouter model). Typically a smaller, cheaper, faster model than the one delegating. When omitted, the model from the outer API request is used. The subagent tool itself cannot be the subagent model. | ~anthropic/claude-haiku-latest | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for this subagent. The model sees one tool per named subagent (and one default for an unnamed entry). Names must be unique across subagent entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | summarizer | -| `Reasoning` | [*components.SubagentReasoning](../../models/components/subagentreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to the subagent call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "low"
} | -| `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | -| `Tools` | [][components.SubagentNestedTool](../../models/components/subagentnestedtool.mdx) | :heavy_minus_sign: | Tools the subagent may use while executing a delegated task. The subagent runs as an agentic sub-agent over these tools, then returns its outcome. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the subagent tool itself. | | \ No newline at end of file +| `InheritFunctions` | `*bool` | ➖ | EXPERIMENTAL — subject to change without notice. When true, the subagent inherits every client function defined in the request's top-level `tools` list. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | true | +| `InheritedFunctionNames` | []`string` | ➖ | EXPERIMENTAL — subject to change without notice. Names of the top-level function tools that the subagent will inherit. Any tool that matches by name will be copied fully into the tools array of the subagent. When `inherit_functions` is `true`, this list does nothing, because every client function will be inherited by default. Names are trimmed before validation, so a whitespace-only name is rejected with a `400`. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | [
"lookup_order"
] | +| `Instructions` | `*string` | ➖ | System instructions for the subagent. When omitted, the subagent responds with no system prompt of its own. | You are a fast, focused worker. Complete the task exactly as described. | +| `MaxCompletionTokens` | `*int64` | ➖ | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | +| `MaxToolCalls` | `*int64` | ➖ | Maximum number of tool-calling steps the subagent may take during its agentic loop. Capped at 25. Only relevant when the subagent is given tools. Forwarded to the subagent call as `max_tool_calls`. | 5 | +| `Model` | `*string` | ➖ | Slug of the model that executes delegated tasks (any OpenRouter model). Typically a smaller, cheaper, faster model than the one delegating. When omitted, the model from the outer API request is used. The subagent tool itself cannot be the subagent model. | ~anthropic/claude-haiku-latest | +| `Name` | `*string` | ➖ | Optional name for this subagent. The model sees one tool per named subagent (and one default for an unnamed entry). Names must be unique across subagent entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | summarizer | +| `Reasoning` | [*components.SubagentReasoning](../../models/components/subagentreasoning.mdx) | ➖ | Reasoning configuration forwarded to the subagent call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "low"
} | +| `Temperature` | `*float64` | ➖ | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | +| `Tools` | [][components.SubagentNestedTool](../../models/components/subagentnestedtool.mdx) | ➖ | Tools the subagent may use while executing a delegated task. The subagent runs as an agentic sub-agent over these tools, then returns its outcome. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the subagent tool itself. | | \ No newline at end of file diff --git a/docs/models/components/subagentservertoolopenrouter.mdx b/docs/models/components/subagentservertoolopenrouter.mdx index b14fa52d4..63fa3a71f 100644 --- a/docs/models/components/subagentservertoolopenrouter.mdx +++ b/docs/models/components/subagentservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: delegates self-contained tasks to a smaller, ch | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.SubagentServerToolConfig](../../models/components/subagentservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | -| `Type` | [components.SubagentServerToolOpenRouterType](../../models/components/subagentservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.SubagentServerToolConfig](../../models/components/subagentservertoolconfig.mdx) | ➖ | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | +| `Type` | [components.SubagentServerToolOpenRouterType](../../models/components/subagentservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/submitgenerationfeedbackrequest.mdx b/docs/models/components/submitgenerationfeedbackrequest.mdx index 2f85badb8..1487690fe 100644 --- a/docs/models/components/submitgenerationfeedbackrequest.mdx +++ b/docs/models/components/submitgenerationfeedbackrequest.mdx @@ -9,6 +9,6 @@ Structured feedback about a specific generation | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Category` | [components.SubmitGenerationFeedbackRequestCategory](../../models/components/submitgenerationfeedbackrequestcategory.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | -| `Comment` | `*string` | :heavy_minus_sign: | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | -| `GenerationID` | `string` | :heavy_check_mark: | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file +| `Category` | [components.SubmitGenerationFeedbackRequestCategory](../../models/components/submitgenerationfeedbackrequestcategory.mdx) | ✅ | The category of feedback being reported | incorrect_response | +| `Comment` | `*string` | ➖ | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | +| `GenerationID` | `string` | ✅ | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file diff --git a/docs/models/components/submitgenerationfeedbackresponse.mdx b/docs/models/components/submitgenerationfeedbackresponse.mdx index c4c9de38c..5dcfa30ff 100644 --- a/docs/models/components/submitgenerationfeedbackresponse.mdx +++ b/docs/models/components/submitgenerationfeedbackresponse.mdx @@ -9,4 +9,4 @@ Confirmation that the feedback was recorded | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.SubmitGenerationFeedbackResponseData](../../models/components/submitgenerationfeedbackresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.SubmitGenerationFeedbackResponseData](../../models/components/submitgenerationfeedbackresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/submitgenerationfeedbackresponsedata.mdx b/docs/models/components/submitgenerationfeedbackresponsedata.mdx index 8b77b76c5..8cca376ac 100644 --- a/docs/models/components/submitgenerationfeedbackresponsedata.mdx +++ b/docs/models/components/submitgenerationfeedbackresponsedata.mdx @@ -6,4 +6,4 @@ title: "SubmitGenerationFeedbackResponseData" | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `Success` | `bool` | :heavy_check_mark: | Whether the feedback was recorded | true | \ No newline at end of file +| `Success` | `bool` | ✅ | Whether the feedback was recorded | true | \ No newline at end of file diff --git a/docs/models/components/suspendinternresponse.mdx b/docs/models/components/suspendinternresponse.mdx index 5f1fdbb8f..c7e5fd966 100644 --- a/docs/models/components/suspendinternresponse.mdx +++ b/docs/models/components/suspendinternresponse.mdx @@ -6,4 +6,4 @@ title: "SuspendInternResponse" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Suspended` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Suspended` | `bool` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/switchyardrouterplugin.mdx b/docs/models/components/switchyardrouterplugin.mdx index c4b4857f2..5755a0eed 100644 --- a/docs/models/components/switchyardrouterplugin.mdx +++ b/docs/models/components/switchyardrouterplugin.mdx @@ -6,6 +6,6 @@ title: "SwitchyardRouterPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Algorithm` | [*components.Algorithm](../../models/components/algorithm.mdx) | :heavy_minus_sign: | Routing algorithm for this request. "capability" calls a small judge model to rate how demanding the task is, then picks the efficient or capable candidate. "stage" reads the tool-result history (errors, repeated failures, edits landing) and calls the judge only when those signals are undecided. "auto" is "stage" without the judge call. "random" picks one candidate at random. "composite" keeps the tier chosen on the last human turn and re-evaluates tool turns with the stage signals. "passthrough" serves the eligible candidates in the order OpenRouter already ranked them, with no routing decision and no judge call. Omit this field to use the platform default, stage. | | -| `ID` | [components.SwitchyardRouterPluginID](../../models/components/switchyardrouterpluginid.mdx) | :heavy_check_mark: | N/A | | -| `JudgeModel` | `*string` | :heavy_minus_sign: | The model that runs the judge call for the judge-backed algorithms ("capability", "stage", and "composite"). The model must support structured outputs and have a provider that your account and request settings allow. Otherwise, the request uses the platform default judge, google/gemini-3.5-flash-lite, or openai/gpt-4o-mini when the default does not fit either, and reports the reason in the routing metadata. The judge call is billed to you like any other request. | openai/gpt-5.4-nano | \ No newline at end of file +| `Algorithm` | [*components.Algorithm](../../models/components/algorithm.mdx) | ➖ | Routing algorithm for this request. "capability" calls a small judge model to rate how demanding the task is, then picks the efficient or capable candidate. "stage" reads the tool-result history (errors, repeated failures, edits landing) and calls the judge only when those signals are undecided. "auto" is "stage" without the judge call. "random" picks one candidate at random. "composite" keeps the tier chosen on the last human turn and re-evaluates tool turns with the stage signals. "passthrough" serves the eligible candidates in the order OpenRouter already ranked them, with no routing decision and no judge call. Omit this field to use the platform default, stage. | | +| `ID` | [components.SwitchyardRouterPluginID](../../models/components/switchyardrouterpluginid.mdx) | ✅ | N/A | | +| `JudgeModel` | `*string` | ➖ | The model that runs the judge call for the judge-backed algorithms ("capability", "stage", and "composite"). The model must support structured outputs and have a provider that your account and request settings allow. Otherwise, the request uses the platform default judge, google/gemini-3.5-flash-lite, or openai/gpt-4o-mini when the default does not fit either, and reports the reason in the routing metadata. The judge call is billed to you like any other request. | openai/gpt-5.4-nano | \ No newline at end of file diff --git a/docs/models/components/taskbudget.mdx b/docs/models/components/taskbudget.mdx index c59ed5701..94cb1d952 100644 --- a/docs/models/components/taskbudget.mdx +++ b/docs/models/components/taskbudget.mdx @@ -9,6 +9,6 @@ Task budget for an agentic turn. The model sees a countdown of remaining tokens | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Remaining` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `Total` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeTokens](../../models/components/typetokens.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Remaining` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | +| `Total` | `int64` | ✅ | N/A | +| `Type` | [components.TypeTokens](../../models/components/typetokens.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/taskclassificationitem.mdx b/docs/models/components/taskclassificationitem.mdx index a045e9e59..e90fc3ba0 100644 --- a/docs/models/components/taskclassificationitem.mdx +++ b/docs/models/components/taskclassificationitem.mdx @@ -6,11 +6,11 @@ title: "TaskClassificationItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CategoryTokenShare` | `float64` | :heavy_check_mark: | Fraction of this classification's token volume within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.48 | -| `CategoryUsageShare` | `float64` | :heavy_check_mark: | Fraction of this classification's usage within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.51 | -| `DisplayName` | `string` | :heavy_check_mark: | Human-readable label for the classification. | Code Generation | -| `MacroCategory` | `string` | :heavy_check_mark: | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | -| `Models` | [][components.TaskClassificationModel](../../models/components/taskclassificationmodel.mdx) | :heavy_check_mark: | Top models for this classification by request volume, sorted descending. Each entry reports the model's share of this classification's requests and tokens. | | -| `Tag` | `string` | :heavy_check_mark: | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | -| `TokenShare` | `float64` | :heavy_check_mark: | Fraction of classified sampled token volume (prompt + completion) attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.31 | -| `UsageShare` | `float64` | :heavy_check_mark: | Fraction of classified sampled requests attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.23 | \ No newline at end of file +| `CategoryTokenShare` | `float64` | ✅ | Fraction of this classification's token volume within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.48 | +| `CategoryUsageShare` | `float64` | ✅ | Fraction of this classification's usage within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.51 | +| `DisplayName` | `string` | ✅ | Human-readable label for the classification. | Code Generation | +| `MacroCategory` | `string` | ✅ | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | +| `Models` | [][components.TaskClassificationModel](../../models/components/taskclassificationmodel.mdx) | ✅ | Top models for this classification by request volume, sorted descending. Each entry reports the model's share of this classification's requests and tokens. | | +| `Tag` | `string` | ✅ | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | +| `TokenShare` | `float64` | ✅ | Fraction of classified sampled token volume (prompt + completion) attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.31 | +| `UsageShare` | `float64` | ✅ | Fraction of classified sampled requests attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.23 | \ No newline at end of file diff --git a/docs/models/components/taskclassificationmacrocategory.mdx b/docs/models/components/taskclassificationmacrocategory.mdx index 82dc99918..893afac08 100644 --- a/docs/models/components/taskclassificationmacrocategory.mdx +++ b/docs/models/components/taskclassificationmacrocategory.mdx @@ -6,7 +6,7 @@ title: "TaskClassificationMacroCategory" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Key` | `string` | :heavy_check_mark: | Macro-category identifier. | code | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the macro-category. | Code | -| `TokenShare` | `float64` | :heavy_check_mark: | Combined token share of all classifications in this macro-category (0–1). | 0.52 | -| `UsageShare` | `float64` | :heavy_check_mark: | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file +| `Key` | `string` | ✅ | Macro-category identifier. | code | +| `Label` | `string` | ✅ | Human-readable label for the macro-category. | Code | +| `TokenShare` | `float64` | ✅ | Combined token share of all classifications in this macro-category (0–1). | 0.52 | +| `UsageShare` | `float64` | ✅ | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file diff --git a/docs/models/components/taskclassificationmodel.mdx b/docs/models/components/taskclassificationmodel.mdx index 0ae63dab3..edb6e0690 100644 --- a/docs/models/components/taskclassificationmodel.mdx +++ b/docs/models/components/taskclassificationmodel.mdx @@ -6,6 +6,6 @@ title: "TaskClassificationModel" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | Model identifier (permaslug). | openai/gpt-4.1-mini | -| `TagTokenShare` | `float64` | :heavy_check_mark: | Fraction of this classification's sampled token volume attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.75 | -| `TagUsageShare` | `float64` | :heavy_check_mark: | Fraction of this classification's sampled requests attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.55 | \ No newline at end of file +| `ID` | `string` | ✅ | Model identifier (permaslug). | openai/gpt-4.1-mini | +| `TagTokenShare` | `float64` | ✅ | Fraction of this classification's sampled token volume attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.75 | +| `TagUsageShare` | `float64` | ✅ | Fraction of this classification's sampled requests attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.55 | \ No newline at end of file diff --git a/docs/models/components/taskclassificationresponse.mdx b/docs/models/components/taskclassificationresponse.mdx index 2e98b3220..165cd4a38 100644 --- a/docs/models/components/taskclassificationresponse.mdx +++ b/docs/models/components/taskclassificationresponse.mdx @@ -6,4 +6,4 @@ title: "TaskClassificationResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Data` | [components.TaskClassificationResponseData](../../models/components/taskclassificationresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.TaskClassificationResponseData](../../models/components/taskclassificationresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/taskclassificationresponsedata.mdx b/docs/models/components/taskclassificationresponsedata.mdx index 829d78b70..ef7557b6f 100644 --- a/docs/models/components/taskclassificationresponsedata.mdx +++ b/docs/models/components/taskclassificationresponsedata.mdx @@ -6,7 +6,7 @@ title: "TaskClassificationResponseData" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | :heavy_check_mark: | UTC date (YYYY-MM-DD) of the window upper bound (yesterday). Data is exclusive of the current incomplete UTC day. This is the expected latest date in the snapshot; it does not confirm data presence for that date. | 2026-06-17 | -| `Classifications` | [][components.TaskClassificationItem](../../models/components/taskclassificationitem.mdx) | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | -| `MacroCategories` | [][components.TaskClassificationMacroCategory](../../models/components/taskclassificationmacrocategory.mdx) | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | -| `WindowDays` | `int64` | :heavy_check_mark: | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file +| `AsOf` | `string` | ✅ | UTC date (YYYY-MM-DD) of the window upper bound (yesterday). Data is exclusive of the current incomplete UTC day. This is the expected latest date in the snapshot; it does not confirm data presence for that date. | 2026-06-17 | +| `Classifications` | [][components.TaskClassificationItem](../../models/components/taskclassificationitem.mdx) | ✅ | Per-task classification market-share data, sorted by usage_share descending. | | +| `MacroCategories` | [][components.TaskClassificationMacroCategory](../../models/components/taskclassificationmacrocategory.mdx) | ✅ | Aggregate market-share data per macro-category (code, data, agent, general). | | +| `WindowDays` | `int64` | ✅ | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file diff --git a/docs/models/components/textdeltaevent.mdx b/docs/models/components/textdeltaevent.mdx index a59e7d5a7..70295e2f9 100644 --- a/docs/models/components/textdeltaevent.mdx +++ b/docs/models/components/textdeltaevent.mdx @@ -9,10 +9,10 @@ Event emitted when a text delta is streamed | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.TextDeltaEventType](../../models/components/textdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | ✅ | N/A | +| `Delta` | `string` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.TextDeltaEventType](../../models/components/textdeltaeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/textdoneevent.mdx b/docs/models/components/textdoneevent.mdx index 3f947ad4a..13414eb8f 100644 --- a/docs/models/components/textdoneevent.mdx +++ b/docs/models/components/textdoneevent.mdx @@ -9,10 +9,10 @@ Event emitted when text streaming is complete | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TextDoneEventType](../../models/components/textdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ContentIndex` | `int64` | ✅ | N/A | +| `ItemID` | `string` | ✅ | N/A | +| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Text` | `string` | ✅ | N/A | +| `Type` | [components.TextDoneEventType](../../models/components/textdoneeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/textextendedconfig.mdx b/docs/models/components/textextendedconfig.mdx index 908cb333c..3770834cd 100644 --- a/docs/models/components/textextendedconfig.mdx +++ b/docs/models/components/textextendedconfig.mdx @@ -9,5 +9,5 @@ Text output configuration including format and verbosity | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Format` | [*components.Formats](../../models/components/formats.mdx) | :heavy_minus_sign: | Text response format configuration | \{
"type": "text"
} | -| `Verbosity` | optionalnullable.OptionalNullable[[components.Verbosity](../../models/components/verbosity.mdx)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Format` | [*components.Formats](../../models/components/formats.mdx) | ➖ | Text response format configuration | \{
"type": "text"
} | +| `Verbosity` | optionalnullable.OptionalNullable[[components.Verbosity](../../models/components/verbosity.mdx)] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/textgeneration.mdx b/docs/models/components/textgeneration.mdx index 6e8bb5af4..5fb004bd2 100644 --- a/docs/models/components/textgeneration.mdx +++ b/docs/models/components/textgeneration.mdx @@ -6,6 +6,6 @@ title: "TextGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/thinkingadaptive.mdx b/docs/models/components/thinkingadaptive.mdx index 6fb273f81..d61b08341 100644 --- a/docs/models/components/thinkingadaptive.mdx +++ b/docs/models/components/thinkingadaptive.mdx @@ -6,6 +6,6 @@ title: "ThinkingAdaptive" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `BlockBinding` | optionalnullable.OptionalNullable[[components.AnthropicThinkingBlockBinding](../../models/components/anthropicthinkingblockbinding.mdx)] | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | :heavy_minus_sign: | N/A | summarized | -| `Type` | [components.TypeAdaptive](../../models/components/typeadaptive.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `BlockBinding` | optionalnullable.OptionalNullable[[components.AnthropicThinkingBlockBinding](../../models/components/anthropicthinkingblockbinding.mdx)] | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | ➖ | N/A | summarized | +| `Type` | [components.TypeAdaptive](../../models/components/typeadaptive.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/thinkingbetweentools.mdx b/docs/models/components/thinkingbetweentools.mdx index 46973e9e6..198f80cee 100644 --- a/docs/models/components/thinkingbetweentools.mdx +++ b/docs/models/components/thinkingbetweentools.mdx @@ -6,4 +6,4 @@ title: "ThinkingBetweenTools" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Type` | [components.TypeBetweenTools](../../models/components/typebetweentools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeBetweenTools](../../models/components/typebetweentools.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/thinkingdisabled.mdx b/docs/models/components/thinkingdisabled.mdx index 22ded428c..c8b9b230a 100644 --- a/docs/models/components/thinkingdisabled.mdx +++ b/docs/models/components/thinkingdisabled.mdx @@ -6,4 +6,4 @@ title: "ThinkingDisabled" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.ThinkingTypeDisabled](../../models/components/thinkingtypedisabled.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ThinkingTypeDisabled](../../models/components/thinkingtypedisabled.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/thinkingenabled.mdx b/docs/models/components/thinkingenabled.mdx index 3688aa85d..ee4e54d92 100644 --- a/docs/models/components/thinkingenabled.mdx +++ b/docs/models/components/thinkingenabled.mdx @@ -6,7 +6,7 @@ title: "ThinkingEnabled" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `BlockBinding` | optionalnullable.OptionalNullable[[components.AnthropicThinkingBlockBinding](../../models/components/anthropicthinkingblockbinding.mdx)] | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `BudgetTokens` | `int64` | :heavy_check_mark: | N/A | | -| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | :heavy_minus_sign: | N/A | summarized | -| `Type` | [components.TypeEnabled](../../models/components/typeenabled.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `BlockBinding` | optionalnullable.OptionalNullable[[components.AnthropicThinkingBlockBinding](../../models/components/anthropicthinkingblockbinding.mdx)] | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `BudgetTokens` | `int64` | ✅ | N/A | | +| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | ➖ | N/A | summarized | +| `Type` | [components.TypeEnabled](../../models/components/typeenabled.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/tokenexchangerequest.mdx b/docs/models/components/tokenexchangerequest.mdx index af5fa8f94..b3dea23e9 100644 --- a/docs/models/components/tokenexchangerequest.mdx +++ b/docs/models/components/tokenexchangerequest.mdx @@ -9,9 +9,9 @@ RFC 8693 token exchange request body (application/x-www-form-urlencoded). | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `FederationPolicyID` | `string` | :heavy_check_mark: | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | -| `GrantType` | [components.GrantType](../../models/components/granttype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | -| `RequestedTokenType` | [*components.RequestedTokenType](../../models/components/requestedtokentype.mdx) | :heavy_minus_sign: | Optional; when present must be `urn:ietf:params:oauth:token-type:access_token`. | urn:ietf:params:oauth:token-type:access_token | -| `Scope` | [*components.TokenExchangeRequestScope](../../models/components/tokenexchangerequestscope.mdx) | :heavy_minus_sign: | Optional; only `inference` is available. | inference | -| `SubjectToken` | `string` | :heavy_check_mark: | The JWT issued by your identity provider. | \ | -| `SubjectTokenType` | [components.SubjectTokenType](../../models/components/subjecttokentype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | \ No newline at end of file +| `FederationPolicyID` | `string` | ✅ | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | +| `GrantType` | [components.GrantType](../../models/components/granttype.mdx) | ✅ | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | +| `RequestedTokenType` | [*components.RequestedTokenType](../../models/components/requestedtokentype.mdx) | ➖ | Optional; when present must be `urn:ietf:params:oauth:token-type:access_token`. | urn:ietf:params:oauth:token-type:access_token | +| `Scope` | [*components.TokenExchangeRequestScope](../../models/components/tokenexchangerequestscope.mdx) | ➖ | Optional; only `inference` is available. | inference | +| `SubjectToken` | `string` | ✅ | The JWT issued by your identity provider. | \ | +| `SubjectTokenType` | [components.SubjectTokenType](../../models/components/subjecttokentype.mdx) | ✅ | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | \ No newline at end of file diff --git a/docs/models/components/tokenexchangeresponse.mdx b/docs/models/components/tokenexchangeresponse.mdx index c09a73525..dac50be35 100644 --- a/docs/models/components/tokenexchangeresponse.mdx +++ b/docs/models/components/tokenexchangeresponse.mdx @@ -9,8 +9,8 @@ RFC 8693 token exchange response. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `AccessToken` | `string` | :heavy_check_mark: | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | -| `ExpiresIn` | `int64` | :heavy_check_mark: | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | -| `IssuedTokenType` | [components.IssuedTokenType](../../models/components/issuedtokentype.mdx) | :heavy_check_mark: | N/A | urn:ietf:params:oauth:token-type:access_token | -| `Scope` | `string` | :heavy_check_mark: | N/A | inference | -| `TokenType` | [components.TokenType](../../models/components/tokentype.mdx) | :heavy_check_mark: | N/A | Bearer | \ No newline at end of file +| `AccessToken` | `string` | ✅ | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | +| `ExpiresIn` | `int64` | ✅ | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | +| `IssuedTokenType` | [components.IssuedTokenType](../../models/components/issuedtokentype.mdx) | ✅ | N/A | urn:ietf:params:oauth:token-type:access_token | +| `Scope` | `string` | ✅ | N/A | inference | +| `TokenType` | [components.TokenType](../../models/components/tokentype.mdx) | ✅ | N/A | Bearer | \ No newline at end of file diff --git a/docs/models/components/tooladvisor20260301.mdx b/docs/models/components/tooladvisor20260301.mdx index 7f6556104..f48ca1fc9 100644 --- a/docs/models/components/tooladvisor20260301.mdx +++ b/docs/models/components/tooladvisor20260301.mdx @@ -6,11 +6,11 @@ title: "ToolAdvisor20260301" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Caching` | optionalnullable.OptionalNullable[[components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | -| `MaxUses` | `*int64` | :heavy_minus_sign: | N/A | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Name` | [components.NameAdvisor](../../models/components/nameadvisor.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeAdvisor20260301](../../models/components/typeadvisor20260301.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | ➖ | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Caching` | optionalnullable.OptionalNullable[[components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx)] | ➖ | N/A | \{
"type": "ephemeral"
} | +| `DeferLoading` | `*bool` | ➖ | N/A | | +| `MaxUses` | `*int64` | ➖ | N/A | | +| `Model` | `string` | ✅ | N/A | | +| `Name` | [components.NameAdvisor](../../models/components/nameadvisor.mdx) | ✅ | N/A | | +| `Type` | [components.TypeAdvisor20260301](../../models/components/typeadvisor20260301.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolbash20250124.mdx b/docs/models/components/toolbash20250124.mdx index 6b1fa0de6..65528022e 100644 --- a/docs/models/components/toolbash20250124.mdx +++ b/docs/models/components/toolbash20250124.mdx @@ -6,6 +6,6 @@ title: "ToolBash20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Name` | [components.NameBash](../../models/components/namebash.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeBash20250124](../../models/components/typebash20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Name` | [components.NameBash](../../models/components/namebash.mdx) | ✅ | N/A | | +| `Type` | [components.TypeBash20250124](../../models/components/typebash20250124.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolcall.mdx b/docs/models/components/toolcall.mdx index 3ba8d0f95..7309e9b58 100644 --- a/docs/models/components/toolcall.mdx +++ b/docs/models/components/toolcall.mdx @@ -6,7 +6,7 @@ title: "ToolCall" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Function` | [components.BatchObjectFunction](../../models/components/batchobjectfunction.mdx) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Index` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ChoiceTypeFunction](../../models/components/choicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Function` | [components.BatchObjectFunction](../../models/components/batchobjectfunction.mdx) | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Index` | `int64` | ✅ | N/A | +| `Type` | [components.ChoiceTypeFunction](../../models/components/choicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoiceallowed.mdx b/docs/models/components/toolchoiceallowed.mdx index 39e02a062..76e8cc3ef 100644 --- a/docs/models/components/toolchoiceallowed.mdx +++ b/docs/models/components/toolchoiceallowed.mdx @@ -9,6 +9,6 @@ Constrains the model to a pre-defined set of allowed tools | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Mode` | [components.Mode](../../models/components/mode.mdx) | :heavy_check_mark: | N/A | -| `Tools` | []map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.ToolChoiceAllowedType](../../models/components/toolchoiceallowedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Mode` | [components.Mode](../../models/components/mode.mdx) | ✅ | N/A | +| `Tools` | []map[string]`any` | ✅ | N/A | +| `Type` | [components.ToolChoiceAllowedType](../../models/components/toolchoiceallowedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoiceany.mdx b/docs/models/components/toolchoiceany.mdx index 0896d1577..e0bf54b3c 100644 --- a/docs/models/components/toolchoiceany.mdx +++ b/docs/models/components/toolchoiceany.mdx @@ -6,5 +6,5 @@ title: "ToolChoiceAny" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeAny](../../models/components/typeany.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `DisableParallelToolUse` | `*bool` | ➖ | N/A | +| `Type` | [components.TypeAny](../../models/components/typeany.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoiceauto.mdx b/docs/models/components/toolchoiceauto.mdx index 41a391880..61a434777 100644 --- a/docs/models/components/toolchoiceauto.mdx +++ b/docs/models/components/toolchoiceauto.mdx @@ -6,5 +6,5 @@ title: "ToolChoiceAuto" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | -| `Type` | [components.ToolChoiceTypeAuto](../../models/components/toolchoicetypeauto.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `DisableParallelToolUse` | `*bool` | ➖ | N/A | +| `Type` | [components.ToolChoiceTypeAuto](../../models/components/toolchoicetypeauto.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoicenone.mdx b/docs/models/components/toolchoicenone.mdx index 0b431b9a6..4a0dc016a 100644 --- a/docs/models/components/toolchoicenone.mdx +++ b/docs/models/components/toolchoicenone.mdx @@ -6,4 +6,4 @@ title: "ToolChoiceNone" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Type` | [components.TypeNone](../../models/components/typenone.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeNone](../../models/components/typenone.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoicesupport.mdx b/docs/models/components/toolchoicesupport.mdx index 682bee4e9..0ddd26b8f 100644 --- a/docs/models/components/toolchoicesupport.mdx +++ b/docs/models/components/toolchoicesupport.mdx @@ -9,7 +9,7 @@ Per-variant `tool_choice` support. `tool_choice` in `supported_parameters` only | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Auto` | `bool` | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "auto"`. | -| `Function` | `bool` | :heavy_check_mark: | Whether the endpoint supports naming a function, `"tool_choice": {"type": "function", ...}`. | -| `None` | `bool` | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "none"`. | -| `Required` | `bool` | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "required"`. | \ No newline at end of file +| `Auto` | `bool` | ✅ | Whether the endpoint supports `"tool_choice": "auto"`. | +| `Function` | `bool` | ✅ | Whether the endpoint supports naming a function, `"tool_choice": {"type": "function", ...}`. | +| `None` | `bool` | ✅ | Whether the endpoint supports `"tool_choice": "none"`. | +| `Required` | `bool` | ✅ | Whether the endpoint supports `"tool_choice": "required"`. | \ No newline at end of file diff --git a/docs/models/components/toolchoicetool.mdx b/docs/models/components/toolchoicetool.mdx index 42539fc3e..d666dad76 100644 --- a/docs/models/components/toolchoicetool.mdx +++ b/docs/models/components/toolchoicetool.mdx @@ -6,6 +6,6 @@ title: "ToolChoiceTool" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeTool](../../models/components/typetool.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `DisableParallelToolUse` | `*bool` | ➖ | N/A | +| `Name` | `string` | ✅ | N/A | +| `Type` | [components.TypeTool](../../models/components/typetool.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolcustom.mdx b/docs/models/components/toolcustom.mdx index 8b8aabd4d..f7e23ae5f 100644 --- a/docs/models/components/toolcustom.mdx +++ b/docs/models/components/toolcustom.mdx @@ -6,10 +6,10 @@ title: "ToolCustom" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | -| `Description` | `*string` | :heavy_minus_sign: | N/A | | -| `InputSchema` | [components.InputSchema](../../models/components/inputschema.mdx) | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Strict` | `*bool` | :heavy_minus_sign: | N/A | | -| `Type` | [*components.ToolTypeCustom](../../models/components/tooltypecustom.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `DeferLoading` | `*bool` | ➖ | N/A | | +| `Description` | `*string` | ➖ | N/A | | +| `InputSchema` | [components.InputSchema](../../models/components/inputschema.mdx) | ✅ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Strict` | `*bool` | ➖ | N/A | | +| `Type` | [*components.ToolTypeCustom](../../models/components/tooltypecustom.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolsearchcallitem.mdx b/docs/models/components/toolsearchcallitem.mdx index 27a27b2fa..46dd8ead6 100644 --- a/docs/models/components/toolsearchcallitem.mdx +++ b/docs/models/components/toolsearchcallitem.mdx @@ -9,9 +9,9 @@ A tool search call the client executed | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `any` | :heavy_minus_sign: | N/A | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `Execution` | [components.ToolSearchCallItemExecution](../../models/components/toolsearchcallitemexecution.mdx) | :heavy_check_mark: | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Status` | optionalnullable.OptionalNullable[[components.ToolSearchCallItemStatus](../../models/components/toolsearchcallitemstatus.mdx)] | :heavy_minus_sign: | N/A | -| `Type` | [components.ToolSearchCallItemType](../../models/components/toolsearchcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Arguments` | `any` | ➖ | N/A | +| `CallID` | `string` | ✅ | N/A | +| `Execution` | [components.ToolSearchCallItemExecution](../../models/components/toolsearchcallitemexecution.mdx) | ✅ | N/A | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Status` | optionalnullable.OptionalNullable[[components.ToolSearchCallItemStatus](../../models/components/toolsearchcallitemstatus.mdx)] | ➖ | N/A | +| `Type` | [components.ToolSearchCallItemType](../../models/components/toolsearchcallitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolsearchoutputitem.mdx b/docs/models/components/toolsearchoutputitem.mdx index acb5494c9..27526276f 100644 --- a/docs/models/components/toolsearchoutputitem.mdx +++ b/docs/models/components/toolsearchoutputitem.mdx @@ -9,9 +9,9 @@ The tools a client-executed tool search loaded | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `Execution` | [components.ToolSearchOutputItemExecution](../../models/components/toolsearchoutputitemexecution.mdx) | :heavy_check_mark: | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Status` | optionalnullable.OptionalNullable[[components.ToolSearchOutputItemStatus](../../models/components/toolsearchoutputitemstatus.mdx)] | :heavy_minus_sign: | N/A | -| `Tools` | [][components.ToolSearchOutputItemToolUnion](../../models/components/toolsearchoutputitemtoolunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.TypeToolSearchOutput](../../models/components/typetoolsearchoutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CallID` | `string` | ✅ | N/A | +| `Execution` | [components.ToolSearchOutputItemExecution](../../models/components/toolsearchoutputitemexecution.mdx) | ✅ | N/A | +| `ID` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Status` | optionalnullable.OptionalNullable[[components.ToolSearchOutputItemStatus](../../models/components/toolsearchoutputitemstatus.mdx)] | ➖ | N/A | +| `Tools` | [][components.ToolSearchOutputItemToolUnion](../../models/components/toolsearchoutputitemtoolunion.mdx) | ✅ | N/A | +| `Type` | [components.TypeToolSearchOutput](../../models/components/typetoolsearchoutput.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolsearchoutputitemtool.mdx b/docs/models/components/toolsearchoutputitemtool.mdx index fb1397335..1998f90de 100644 --- a/docs/models/components/toolsearchoutputitemtool.mdx +++ b/docs/models/components/toolsearchoutputitemtool.mdx @@ -6,5 +6,5 @@ title: "ToolSearchOutputItemTool" | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | `string` | ✅ | N/A | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/toolsearchoutputitemtoolfunction.mdx b/docs/models/components/toolsearchoutputitemtoolfunction.mdx index 93783a9a9..02112f21f 100644 --- a/docs/models/components/toolsearchoutputitemtoolfunction.mdx +++ b/docs/models/components/toolsearchoutputitemtoolfunction.mdx @@ -9,10 +9,10 @@ Function tool definition | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.ToolSearchOutputItemTypeFunction](../../models/components/toolsearchoutputitemtypefunction.mdx) | :heavy_check_mark: | N/A | | -| `Async` | `*bool` | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `DeferLoading` | `*bool` | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | | +| `Name` | `string` | ✅ | N/A | | +| `Parameters` | map[string]`any` | ✅ | N/A | | +| `Strict` | optionalnullable.OptionalNullable[`bool`] | ➖ | N/A | | +| `Type` | [components.ToolSearchOutputItemTypeFunction](../../models/components/toolsearchoutputitemtypefunction.mdx) | ✅ | N/A | | +| `Async` | `*bool` | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `DeferLoading` | `*bool` | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/components/toolsearchservertool.mdx b/docs/models/components/toolsearchservertool.mdx index 39e574fea..466ee3476 100644 --- a/docs/models/components/toolsearchservertool.mdx +++ b/docs/models/components/toolsearchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: finds tools marked `defer_loading` and makes th | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ToolSearchServerToolConfig](../../models/components/toolsearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | -| `Type` | [components.ToolSearchServerToolType](../../models/components/toolsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.ToolSearchServerToolConfig](../../models/components/toolsearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | +| `Type` | [components.ToolSearchServerToolType](../../models/components/toolsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolsearchservertoolconfig.mdx b/docs/models/components/toolsearchservertoolconfig.mdx index 85ad9eb81..7a0423737 100644 --- a/docs/models/components/toolsearchservertoolconfig.mdx +++ b/docs/models/components/toolsearchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:tool_search server tool | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file +| `MaxResults` | `*int64` | ➖ | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file diff --git a/docs/models/components/tooltexteditor20250124.mdx b/docs/models/components/tooltexteditor20250124.mdx index 5ae15508a..c8a0aecad 100644 --- a/docs/models/components/tooltexteditor20250124.mdx +++ b/docs/models/components/tooltexteditor20250124.mdx @@ -6,6 +6,6 @@ title: "ToolTextEditor20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `Name` | [components.NameStrReplaceEditor](../../models/components/namestrreplaceeditor.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeTextEditor20250124](../../models/components/typetexteditor20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `Name` | [components.NameStrReplaceEditor](../../models/components/namestrreplaceeditor.mdx) | ✅ | N/A | | +| `Type` | [components.TypeTextEditor20250124](../../models/components/typetexteditor20250124.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolwebsearch20250305.mdx b/docs/models/components/toolwebsearch20250305.mdx index a3da68845..de6f69078 100644 --- a/docs/models/components/toolwebsearch20250305.mdx +++ b/docs/models/components/toolwebsearch20250305.mdx @@ -6,10 +6,10 @@ title: "ToolWebSearch20250305" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Name` | [components.NameWebSearch1](../../models/components/namewebsearch1.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeWebSearch20250305](../../models/components/typewebsearch20250305.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | +| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | +| `Name` | [components.NameWebSearch1](../../models/components/namewebsearch1.mdx) | ✅ | N/A | | +| `Type` | [components.TypeWebSearch20250305](../../models/components/typewebsearch20250305.mdx) | ✅ | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/toolwebsearch20260209.mdx b/docs/models/components/toolwebsearch20260209.mdx index 0526f22d0..3b8431f3b 100644 --- a/docs/models/components/toolwebsearch20260209.mdx +++ b/docs/models/components/toolwebsearch20260209.mdx @@ -6,11 +6,11 @@ title: "ToolWebSearch20260209" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | -| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Name` | [components.NameWebSearch2](../../models/components/namewebsearch2.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeWebSearch20260209](../../models/components/typewebsearch20260209.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | ➖ | N/A | [
"direct"
] | +| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | +| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | | +| `Name` | [components.NameWebSearch2](../../models/components/namewebsearch2.mdx) | ✅ | N/A | | +| `Type` | [components.TypeWebSearch20260209](../../models/components/typewebsearch20260209.mdx) | ✅ | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/toomanyrequestsresponseerrordata.mdx b/docs/models/components/toomanyrequestsresponseerrordata.mdx index dba2348b9..617765ea4 100644 --- a/docs/models/components/toomanyrequestsresponseerrordata.mdx +++ b/docs/models/components/toomanyrequestsresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for TooManyRequestsResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/topproviderinfo.mdx b/docs/models/components/topproviderinfo.mdx index 0a9ae8f98..9c35d9d65 100644 --- a/docs/models/components/topproviderinfo.mdx +++ b/docs/models/components/topproviderinfo.mdx @@ -9,6 +9,6 @@ Information about the top provider for this model | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContextLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Context length from the top provider | 8192 | -| `IsModerated` | `bool` | :heavy_check_mark: | Whether the top provider moderates content | true | -| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum completion tokens from the top provider. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | 4096 | \ No newline at end of file +| `ContextLength` | optionalnullable.OptionalNullable[`int64`] | ➖ | Context length from the top provider | 8192 | +| `IsModerated` | `bool` | ✅ | Whether the top provider moderates content | true | +| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum completion tokens from the top provider. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | 4096 | \ No newline at end of file diff --git a/docs/models/components/tournamentstats.mdx b/docs/models/components/tournamentstats.mdx index 02e336b83..d08896a01 100644 --- a/docs/models/components/tournamentstats.mdx +++ b/docs/models/components/tournamentstats.mdx @@ -9,8 +9,8 @@ Placement distribution from tournament matches. | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `FirstPlace` | `*int64` | :heavy_check_mark: | N/A | -| `FourthPlace` | `*int64` | :heavy_check_mark: | N/A | -| `SecondPlace` | `*int64` | :heavy_check_mark: | N/A | -| `ThirdPlace` | `*int64` | :heavy_check_mark: | N/A | -| `Total` | `*int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `FirstPlace` | `*int64` | ✅ | N/A | +| `FourthPlace` | `*int64` | ✅ | N/A | +| `SecondPlace` | `*int64` | ✅ | N/A | +| `ThirdPlace` | `*int64` | ✅ | N/A | +| `Total` | `*int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/traceconfig.mdx b/docs/models/components/traceconfig.mdx index 2ee049277..136352cd4 100644 --- a/docs/models/components/traceconfig.mdx +++ b/docs/models/components/traceconfig.mdx @@ -9,9 +9,9 @@ Metadata for observability and tracing. Known keys (trace_id, trace_name, span_n | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `GenerationName` | `*string` | :heavy_minus_sign: | N/A | | -| `ParentSpanID` | `*string` | :heavy_minus_sign: | N/A | | -| `SpanName` | `*string` | :heavy_minus_sign: | N/A | | -| `TraceID` | `*string` | :heavy_minus_sign: | N/A | | -| `TraceName` | `*string` | :heavy_minus_sign: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file +| `GenerationName` | `*string` | ➖ | N/A | | +| `ParentSpanID` | `*string` | ➖ | N/A | | +| `SpanName` | `*string` | ➖ | N/A | | +| `TraceID` | `*string` | ➖ | N/A | | +| `TraceName` | `*string` | ➖ | N/A | | +| `AdditionalProperties` | map[string]`any` | ➖ | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file diff --git a/docs/models/components/triggerinputtokens.mdx b/docs/models/components/triggerinputtokens.mdx index c03547aba..790379a6e 100644 --- a/docs/models/components/triggerinputtokens.mdx +++ b/docs/models/components/triggerinputtokens.mdx @@ -6,5 +6,5 @@ title: "TriggerInputTokens" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.EditTypeInputTokens](../../models/components/edittypeinputtokens.mdx) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.EditTypeInputTokens](../../models/components/edittypeinputtokens.mdx) | ✅ | N/A | +| `Value` | `int64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/tts.mdx b/docs/models/components/tts.mdx index 7a80a19af..a790919df 100644 --- a/docs/models/components/tts.mdx +++ b/docs/models/components/tts.mdx @@ -6,6 +6,6 @@ title: "TTS" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/unauthorizedresponseerrordata.mdx b/docs/models/components/unauthorizedresponseerrordata.mdx index aec056179..170b1c8ba 100644 --- a/docs/models/components/unauthorizedresponseerrordata.mdx +++ b/docs/models/components/unauthorizedresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for UnauthorizedResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarkpricing.mdx b/docs/models/components/unifiedbenchmarkpricing.mdx index d04711bcb..b08151ce3 100644 --- a/docs/models/components/unifiedbenchmarkpricing.mdx +++ b/docs/models/components/unifiedbenchmarkpricing.mdx @@ -9,5 +9,5 @@ OpenRouter pricing per token for this model. Null if pricing is unavailable. | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `Completion` | `string` | :heavy_check_mark: | Cost per output token (USD, decimal string). | 0.000015 | -| `Prompt` | `string` | :heavy_check_mark: | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file +| `Completion` | `string` | ✅ | Cost per output token (USD, decimal string). | 0.000015 | +| `Prompt` | `string` | ✅ | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksaaitem.mdx b/docs/models/components/unifiedbenchmarksaaitem.mdx index 232deb499..121e4b799 100644 --- a/docs/models/components/unifiedbenchmarksaaitem.mdx +++ b/docs/models/components/unifiedbenchmarksaaitem.mdx @@ -6,10 +6,10 @@ title: "UnifiedBenchmarksAAItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `AgenticIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | -| `CodingIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | -| `DisplayName` | `string` | :heavy_check_mark: | Model name as listed on Artificial Analysis. | GPT-4o | -| `IntelligenceIndex` | `*float64` | :heavy_check_mark: | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `Source` | [components.UnifiedBenchmarksAAItemSource](../../models/components/unifiedbenchmarksaaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | \ No newline at end of file +| `AgenticIndex` | `*float64` | ✅ | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | +| `CodingIndex` | `*float64` | ✅ | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | +| `DisplayName` | `string` | ✅ | Model name as listed on Artificial Analysis. | GPT-4o | +| `IntelligenceIndex` | `*float64` | ✅ | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | +| `ModelPermaslug` | `string` | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `Source` | [components.UnifiedBenchmarksAAItemSource](../../models/components/unifiedbenchmarksaaitemsource.mdx) | ✅ | Benchmark source discriminator. | | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksdaitem.mdx b/docs/models/components/unifiedbenchmarksdaitem.mdx index e55838118..2179eb261 100644 --- a/docs/models/components/unifiedbenchmarksdaitem.mdx +++ b/docs/models/components/unifiedbenchmarksdaitem.mdx @@ -6,13 +6,13 @@ title: "UnifiedBenchmarksDAItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Arena` | `string` | :heavy_check_mark: | Arena this ranking belongs to. | models | -| `AvgGenerationTimeMs` | `*float64` | :heavy_check_mark: | Average generation time in milliseconds. | 3200 | -| `Category` | `string` | :heavy_check_mark: | Category within the arena. | codecategories | -| `DisplayName` | `string` | :heavy_check_mark: | Human-readable model name from Design Arena. | Claude Sonnet 4 | -| `Elo` | `float64` | :heavy_check_mark: | ELO rating from head-to-head arena battles. | 1423 | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | -| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `Source` | [components.UnifiedBenchmarksDAItemSource](../../models/components/unifiedbenchmarksdaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `TournamentStats` | [components.TournamentStats](../../models/components/tournamentstats.mdx) | :heavy_check_mark: | Placement distribution from tournament matches. | | -| `WinRate` | `float64` | :heavy_check_mark: | Win rate as a percentage (0–100). | 72 | \ No newline at end of file +| `Arena` | `string` | ✅ | Arena this ranking belongs to. | models | +| `AvgGenerationTimeMs` | `*float64` | ✅ | Average generation time in milliseconds. | 3200 | +| `Category` | `string` | ✅ | Category within the arena. | codecategories | +| `DisplayName` | `string` | ✅ | Human-readable model name from Design Arena. | Claude Sonnet 4 | +| `Elo` | `float64` | ✅ | ELO rating from head-to-head arena battles. | 1423 | +| `ModelPermaslug` | `string` | ✅ | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | +| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `Source` | [components.UnifiedBenchmarksDAItemSource](../../models/components/unifiedbenchmarksdaitemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `TournamentStats` | [components.TournamentStats](../../models/components/tournamentstats.mdx) | ✅ | Placement distribution from tournament matches. | | +| `WinRate` | `float64` | ✅ | Win rate as a percentage (0–100). | 72 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksmeta.mdx b/docs/models/components/unifiedbenchmarksmeta.mdx index d5e63e719..5e4f54e6c 100644 --- a/docs/models/components/unifiedbenchmarksmeta.mdx +++ b/docs/models/components/unifiedbenchmarksmeta.mdx @@ -6,10 +6,10 @@ title: "UnifiedBenchmarksMeta" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | :heavy_check_mark: | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | -| `Citation` | `*string` | :heavy_check_mark: | Required attribution when republishing this data, or null when results span multiple sources (attribute each item individually by its `source` discriminator). | Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings). | -| `ModelCount` | `int64` | :heavy_check_mark: | Number of unique models in the response. | | -| `Source` | [*components.UnifiedBenchmarksMetaSource](../../models/components/unifiedbenchmarksmetasource.mdx) | :heavy_check_mark: | The source filter applied, or null when all sources are returned. | artificial-analysis | -| `SourceURL` | `*string` | :heavy_check_mark: | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | -| `TaskType` | `*string` | :heavy_check_mark: | The task_type filter applied, or null if showing all. | | -| `Version` | [components.UnifiedBenchmarksMetaVersion](../../models/components/unifiedbenchmarksmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file +| `AsOf` | `string` | ✅ | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | +| `Citation` | `*string` | ✅ | Required attribution when republishing this data, or null when results span multiple sources (attribute each item individually by its `source` discriminator). | Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings). | +| `ModelCount` | `int64` | ✅ | Number of unique models in the response. | | +| `Source` | [*components.UnifiedBenchmarksMetaSource](../../models/components/unifiedbenchmarksmetasource.mdx) | ✅ | The source filter applied, or null when all sources are returned. | artificial-analysis | +| `SourceURL` | `*string` | ✅ | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | +| `TaskType` | `*string` | ✅ | The task_type filter applied, or null if showing all. | | +| `Version` | [components.UnifiedBenchmarksMetaVersion](../../models/components/unifiedbenchmarksmetaversion.mdx) | ✅ | Dataset version. | | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksoritem.mdx b/docs/models/components/unifiedbenchmarksoritem.mdx index 5d1f40d95..66d1cfbe3 100644 --- a/docs/models/components/unifiedbenchmarksoritem.mdx +++ b/docs/models/components/unifiedbenchmarksoritem.mdx @@ -6,12 +6,12 @@ title: "UnifiedBenchmarksORItem" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Accuracy` | `float64` | :heavy_check_mark: | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | -| `AccuracyStddev` | `*float64` | :heavy_check_mark: | Standard deviation of run accuracy, or null for a single run. | 0.03 | -| `AvgCostPerTask` | `*float64` | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.002 | -| `BenchmarkType` | [components.UnifiedBenchmarksORItemBenchmarkType](../../models/components/unifiedbenchmarksoritembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter benchmark evaluation type. | gpqa_diamond | -| `DisplayName` | `string` | :heavy_check_mark: | Human-readable model name. | GPT-4o | -| `LastRunTimestamp` | `string` | :heavy_check_mark: | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `Source` | [components.UnifiedBenchmarksORItemSource](../../models/components/unifiedbenchmarksoritemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `TotalTasks` | `int64` | :heavy_check_mark: | Total benchmark tasks across runs. | 300 | \ No newline at end of file +| `Accuracy` | `float64` | ✅ | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | +| `AccuracyStddev` | `*float64` | ✅ | Standard deviation of run accuracy, or null for a single run. | 0.03 | +| `AvgCostPerTask` | `*float64` | ✅ | Average cost per task in USD, or null if unavailable. | 0.002 | +| `BenchmarkType` | [components.UnifiedBenchmarksORItemBenchmarkType](../../models/components/unifiedbenchmarksoritembenchmarktype.mdx) | ✅ | OpenRouter benchmark evaluation type. | gpqa_diamond | +| `DisplayName` | `string` | ✅ | Human-readable model name. | GPT-4o | +| `LastRunTimestamp` | `string` | ✅ | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | +| `ModelPermaslug` | `string` | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `Source` | [components.UnifiedBenchmarksORItemSource](../../models/components/unifiedbenchmarksoritemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `TotalTasks` | `int64` | ✅ | Total benchmark tasks across runs. | 300 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksresponse.mdx b/docs/models/components/unifiedbenchmarksresponse.mdx index d3443764d..8beed06dd 100644 --- a/docs/models/components/unifiedbenchmarksresponse.mdx +++ b/docs/models/components/unifiedbenchmarksresponse.mdx @@ -6,5 +6,5 @@ title: "UnifiedBenchmarksResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.UnifiedBenchmarksResponseData](../../models/components/unifiedbenchmarksresponsedata.mdx) | :heavy_check_mark: | N/A | | -| `Meta` | [components.UnifiedBenchmarksMeta](../../models/components/unifiedbenchmarksmeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-06-03T12:00:00Z",
"citation": "Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings).",
"model_count": 50,
"source": "artificial-analysis",
"source_url": "https://artificialanalysis.ai",
"task_type": null,
"version": "v1"
} | \ No newline at end of file +| `Data` | [][components.UnifiedBenchmarksResponseData](../../models/components/unifiedbenchmarksresponsedata.mdx) | ✅ | N/A | | +| `Meta` | [components.UnifiedBenchmarksMeta](../../models/components/unifiedbenchmarksmeta.mdx) | ✅ | N/A | \{
"as_of": "2026-06-03T12:00:00Z",
"citation": "Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings).",
"model_count": 50,
"source": "artificial-analysis",
"source_url": "https://artificialanalysis.ai",
"task_type": null,
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarkssearchitem.mdx b/docs/models/components/unifiedbenchmarkssearchitem.mdx index 248720a06..cdc0d75c8 100644 --- a/docs/models/components/unifiedbenchmarkssearchitem.mdx +++ b/docs/models/components/unifiedbenchmarkssearchitem.mdx @@ -6,16 +6,16 @@ title: "UnifiedBenchmarksSearchItem" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AvgCostPerTask` | `*float64` | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.031 | -| `AvgLatencyPerTaskMs` | `*float64` | :heavy_check_mark: | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | -| `BenchmarkType` | [components.UnifiedBenchmarksSearchItemBenchmarkType](../../models/components/unifiedbenchmarkssearchitembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter search benchmark. | search_browsecomp | -| `DisplayName` | `string` | :heavy_check_mark: | Human-readable model name. | GPT-4o | -| `LastRunTimestamp` | `string` | :heavy_check_mark: | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `PrimaryMetric` | [components.PrimaryMetric](../../models/components/primarymetric.mdx) | :heavy_check_mark: | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | -| `PrimaryScore` | `float64` | :heavy_check_mark: | The benchmark's headline score from 0 to 1. Its meaning is identified by `primary_metric`: item-weighted F1 for WideSearch or strict accuracy for the other search benchmarks. Higher is better. | 0.72 | -| `RunConfig` | [*components.UnifiedBenchmarksSearchRunConfig](../../models/components/unifiedbenchmarkssearchrunconfig.mdx) | :heavy_minus_sign: | Published lane configuration, included only when include_run_config=true. Only the agent turn count, reasoning effort, and temperature are exposed; other harness settings are intentionally not part of the public contract. | | -| `SearchEngine` | `string` | :heavy_check_mark: | Search engine the published configuration used. | exa | -| `SearchSurface` | [components.SearchSurface](../../models/components/searchsurface.mdx) | :heavy_check_mark: | Request surface the published configuration went through. | server-tool | -| `Source` | [components.UnifiedBenchmarksSearchItemSource](../../models/components/unifiedbenchmarkssearchitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `TotalTasks` | `int64` | :heavy_check_mark: | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file +| `AvgCostPerTask` | `*float64` | ✅ | Average cost per task in USD, or null if unavailable. | 0.031 | +| `AvgLatencyPerTaskMs` | `*float64` | ✅ | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | +| `BenchmarkType` | [components.UnifiedBenchmarksSearchItemBenchmarkType](../../models/components/unifiedbenchmarkssearchitembenchmarktype.mdx) | ✅ | OpenRouter search benchmark. | search_browsecomp | +| `DisplayName` | `string` | ✅ | Human-readable model name. | GPT-4o | +| `LastRunTimestamp` | `string` | ✅ | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | +| `ModelPermaslug` | `string` | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `PrimaryMetric` | [components.PrimaryMetric](../../models/components/primarymetric.mdx) | ✅ | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | +| `PrimaryScore` | `float64` | ✅ | The benchmark's headline score from 0 to 1. Its meaning is identified by `primary_metric`: item-weighted F1 for WideSearch or strict accuracy for the other search benchmarks. Higher is better. | 0.72 | +| `RunConfig` | [*components.UnifiedBenchmarksSearchRunConfig](../../models/components/unifiedbenchmarkssearchrunconfig.mdx) | ➖ | Published lane configuration, included only when include_run_config=true. Only the agent turn count, reasoning effort, and temperature are exposed; other harness settings are intentionally not part of the public contract. | | +| `SearchEngine` | `string` | ✅ | Search engine the published configuration used. | exa | +| `SearchSurface` | [components.SearchSurface](../../models/components/searchsurface.mdx) | ✅ | Request surface the published configuration went through. | server-tool | +| `Source` | [components.UnifiedBenchmarksSearchItemSource](../../models/components/unifiedbenchmarkssearchitemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `TotalTasks` | `int64` | ✅ | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarkssearchrunconfig.mdx b/docs/models/components/unifiedbenchmarkssearchrunconfig.mdx index 50709bd96..8ad4d2ce9 100644 --- a/docs/models/components/unifiedbenchmarkssearchrunconfig.mdx +++ b/docs/models/components/unifiedbenchmarkssearchrunconfig.mdx @@ -9,6 +9,6 @@ Published lane configuration, included only when include_run_config=true. Only t | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `MaxAgentTurns` | `*int64` | :heavy_check_mark: | Agent-turn count for the published lane, or null for plugin lanes. | 25 | -| `ReasoningEffort` | `*string` | :heavy_check_mark: | Reasoning effort configured for the published lane, or null when omitted. | high | -| `Temperature` | `*float64` | :heavy_check_mark: | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file +| `MaxAgentTurns` | `*int64` | ✅ | Agent-turn count for the published lane, or null for plugin lanes. | 25 | +| `ReasoningEffort` | `*string` | ✅ | Reasoning effort configured for the published lane, or null when omitted. | high | +| `Temperature` | `*float64` | ✅ | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file diff --git a/docs/models/components/uniqueinsight.mdx b/docs/models/components/uniqueinsight.mdx index 859d7df5d..f60bbe32b 100644 --- a/docs/models/components/uniqueinsight.mdx +++ b/docs/models/components/uniqueinsight.mdx @@ -6,5 +6,5 @@ title: "UniqueInsight" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Insight` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Insight` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/unknown.mdx b/docs/models/components/unknown.mdx index 1c8d06f12..42d05d7d1 100644 --- a/docs/models/components/unknown.mdx +++ b/docs/models/components/unknown.mdx @@ -6,6 +6,6 @@ title: "Unknown" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/unprocessableentityresponseerrordata.mdx b/docs/models/components/unprocessableentityresponseerrordata.mdx index 10793193d..6683f0647 100644 --- a/docs/models/components/unprocessableentityresponseerrordata.mdx +++ b/docs/models/components/unprocessableentityresponseerrordata.mdx @@ -9,6 +9,6 @@ Error data for UnprocessableEntityResponse | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Code` | `int64` | ✅ | N/A | +| `Message` | `string` | ✅ | N/A | +| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/updatebyokkeyrequest.mdx b/docs/models/components/updatebyokkeyrequest.mdx index ca7ff75fa..e3a70dc0d 100644 --- a/docs/models/components/updatebyokkeyrequest.mdx +++ b/docs/models/components/updatebyokkeyrequest.mdx @@ -6,14 +6,14 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedAPIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.UpdateBYOKKeyRequestDeclaredRegion](../../models/components/updatebyokkeyrequestdeclaredregion.mdx)] | :heavy_minus_sign: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Omit to leave the stored value unchanged (rotating an OpenAI or Fireworks `key` re-derives it from the new key); `null` clears the declaration. | null | -| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Omit to leave the stored value unchanged; `null` clears the declaration. | null | -| `Disabled` | `*bool` | :heavy_minus_sign: | Whether this credential is disabled. | false | -| `IsBYOKOnly` | `*bool` | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Omit to leave the stored value unchanged. | false | -| `IsFallback` | `*bool` | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. Omit to leave the stored value unchanged. | false | -| `IsRequired` | `*bool` | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Omit to leave the stored value unchanged. | false | -| `Key` | `*string` | :heavy_minus_sign: | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | -| `Name` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file +| `AllowedAPIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.UpdateBYOKKeyRequestDeclaredRegion](../../models/components/updatebyokkeyrequestdeclaredregion.mdx)] | ➖ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Omit to leave the stored value unchanged (rotating an OpenAI or Fireworks `key` re-derives it from the new key); `null` clears the declaration. | null | +| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Omit to leave the stored value unchanged; `null` clears the declaration. | null | +| `Disabled` | `*bool` | ➖ | Whether this credential is disabled. | false | +| `IsBYOKOnly` | `*bool` | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Omit to leave the stored value unchanged. | false | +| `IsFallback` | `*bool` | ➖ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. Omit to leave the stored value unchanged. | false | +| `IsRequired` | `*bool` | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Omit to leave the stored value unchanged. | false | +| `Key` | `*string` | ➖ | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | +| `Name` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file diff --git a/docs/models/components/updatebyokkeyresponse.mdx b/docs/models/components/updatebyokkeyresponse.mdx index 6b4146dcd..55e120c86 100644 --- a/docs/models/components/updatebyokkeyresponse.mdx +++ b/docs/models/components/updatebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateBYOKKeyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.BYOKKey](../../models/components/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/updateenduserrequest.mdx b/docs/models/components/updateenduserrequest.mdx index d17764d8f..ec9d18e3f 100644 --- a/docs/models/components/updateenduserrequest.mdx +++ b/docs/models/components/updateenduserrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateEndUserRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `IsActive` | `bool` | :heavy_check_mark: | Registration state only; does not enforce inference access. | true | \ No newline at end of file +| `IsActive` | `bool` | ✅ | Registration state only; does not enforce inference access. | true | \ No newline at end of file diff --git a/docs/models/components/updateguardrailrequest.mdx b/docs/models/components/updateguardrailrequest.mdx index 33bedfd9d..f9f4c8fca 100644 --- a/docs/models/components/updateguardrailrequest.mdx +++ b/docs/models/components/updateguardrailrequest.mdx @@ -6,24 +6,24 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput.mdx)] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | -| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New description for the guardrail | Updated description | -| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Omit to leave unchanged. | true | -| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | New spending limit in USD | 75 | -| `Name` | `*string` | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file +| `AllowedDataRegions` | optionalnullable.OptionalNullable[[][components.GuardrailDataRegion](../../models/components/guardraildataregion.mdx)] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | +| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | +| `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput.mdx)] | ➖ | Builtin content filters to apply. Set to null to remove. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | +| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | ➖ | Custom regex content filters to apply. Set to null to remove. | null | +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | New description for the guardrail | Updated description | +| `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `EnablePaidModelTraining` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | +| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | +| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | +| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | +| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | true | +| `EnforceZdrXai` | optionalnullable.OptionalNullable[`bool`] | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | +| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Omit to leave unchanged. | true | +| `LimitUsd` | optionalnullable.OptionalNullable[`float64`] | ➖ | New spending limit in USD | 75 | +| `Name` | `*string` | ➖ | New name for the guardrail | Updated Guardrail Name | +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/docs/models/components/updateguardrailresponse.mdx b/docs/models/components/updateguardrailresponse.mdx index 1e5506c82..1bb5f6c1d 100644 --- a/docs/models/components/updateguardrailresponse.mdx +++ b/docs/models/components/updateguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/components/updateinternrequest.mdx b/docs/models/components/updateinternrequest.mdx index d8a2a4bbc..6e6fbaad8 100644 --- a/docs/models/components/updateinternrequest.mdx +++ b/docs/models/components/updateinternrequest.mdx @@ -9,7 +9,7 @@ Lifecycle settings to change. Omitted fields stay unchanged and null clears a fi | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New free-form description. Null clears it. | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New standing instructions. Null clears them. | -| `Model` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New OpenRouter model slug in `author/slug` form (an optional `:variant` suffix is accepted). Other shapes are refused with 400. Null restores the workspace default. Takes effect on the next provision: until then `GET` shows this configured model while chat chunks show the model the running intern reports. | -| `Name` | `*string` | :heavy_minus_sign: | New intern name, unique per creator within the workspace. | \ No newline at end of file +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | New free-form description. Null clears it. | +| `Instructions` | optionalnullable.OptionalNullable[`string`] | ➖ | New standing instructions. Null clears them. | +| `Model` | optionalnullable.OptionalNullable[`string`] | ➖ | New OpenRouter model slug in `author/slug` form (an optional `:variant` suffix is accepted). Other shapes are refused with 400. Null restores the workspace default. Takes effect on the next provision: until then `GET` shows this configured model while chat chunks show the model the running intern reports. | +| `Name` | `*string` | ➖ | New intern name, unique per creator within the workspace. | \ No newline at end of file diff --git a/docs/models/components/updateobservabilitydestinationrequest.mdx b/docs/models/components/updateobservabilitydestinationrequest.mdx index 267a2bfbc..b2fd6ca24 100644 --- a/docs/models/components/updateobservabilitydestinationrequest.mdx +++ b/docs/models/components/updateobservabilitydestinationrequest.mdx @@ -6,14 +6,14 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided. | null | -| `BroadcastGenerationCost` | `*bool` | :heavy_minus_sign: | Whether to include cost and billing generation metadata. | false | -| `BroadcastGenerationIdentity` | `*bool` | :heavy_minus_sign: | Whether to include identity generation metadata. | false | -| `BroadcastGenerationRequestContext` | `*bool` | :heavy_minus_sign: | Whether to include request-context generation metadata. | false | -| `Config` | map[string]`any` | :heavy_minus_sign: | Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | -| `Enabled` | `*bool` | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | :heavy_minus_sign: | N/A | null | -| `Name` | `*string` | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | -| `PrivacyMode` | `*bool` | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `Regions` | [][components.ObservabilityDataRegionInput](../../models/components/observabilitydataregioninput.mdx) | :heavy_minus_sign: | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field keeps the current value; it cannot be cleared. | [
"global"
] | -| `SamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file +| `APIKeyHashes` | optionalnullable.OptionalNullable[[]`string`] | ➖ | Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided. | null | +| `BroadcastGenerationCost` | `*bool` | ➖ | Whether to include cost and billing generation metadata. | false | +| `BroadcastGenerationIdentity` | `*bool` | ➖ | Whether to include identity generation metadata. | false | +| `BroadcastGenerationRequestContext` | `*bool` | ➖ | Whether to include request-context generation metadata. | false | +| `Config` | map[string]`any` | ➖ | Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | +| `Enabled` | `*bool` | ➖ | Whether the destination is enabled. | true | +| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | ➖ | N/A | null | +| `Name` | `*string` | ➖ | Human-readable name for the destination. | Production Langfuse | +| `PrivacyMode` | `*bool` | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | +| `Regions` | [][components.ObservabilityDataRegionInput](../../models/components/observabilitydataregioninput.mdx) | ➖ | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field keeps the current value; it cannot be cleared. | [
"global"
] | +| `SamplingRate` | `*float64` | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/docs/models/components/updateobservabilitydestinationresponse.mdx b/docs/models/components/updateobservabilitydestinationresponse.mdx index 80eae0f51..1e68bd976 100644 --- a/docs/models/components/updateobservabilitydestinationresponse.mdx +++ b/docs/models/components/updateobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/updateorganizationsettingsrequest.mdx b/docs/models/components/updateorganizationsettingsrequest.mdx index 235c01e6f..528d8636e 100644 --- a/docs/models/components/updateorganizationsettingsrequest.mdx +++ b/docs/models/components/updateorganizationsettingsrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateOrganizationSettingsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IsFilteredModelCatalogEnabled` | `bool` | :heavy_check_mark: | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file +| `IsFilteredModelCatalogEnabled` | `bool` | ✅ | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file diff --git a/docs/models/components/updateprivateendpointpricingrequest.mdx b/docs/models/components/updateprivateendpointpricingrequest.mdx index ddbf18c21..b4af5b3b9 100644 --- a/docs/models/components/updateprivateendpointpricingrequest.mdx +++ b/docs/models/components/updateprivateendpointpricingrequest.mdx @@ -6,4 +6,4 @@ title: "UpdatePrivateEndpointPricingRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Pricing` | [components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | \ No newline at end of file +| `Pricing` | [components.PrivateEndpointPricing](../../models/components/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | \ No newline at end of file diff --git a/docs/models/components/updateprivateendpointrequest.mdx b/docs/models/components/updateprivateendpointrequest.mdx index 3587892f3..d19095dac 100644 --- a/docs/models/components/updateprivateendpointrequest.mdx +++ b/docs/models/components/updateprivateendpointrequest.mdx @@ -6,7 +6,7 @@ title: "UpdatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BaseURL` | `*string` | :heavy_minus_sign: | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.UpdatePrivateEndpointRequestDeclaredRegion](../../models/components/updateprivateendpointrequestdeclaredregion.mdx)] | :heavy_minus_sign: | Attest where this deployment processes data. | us | -| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | -| `UpstreamModelID` | `string` | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `BaseURL` | `*string` | ➖ | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `DeclaredRegion` | optionalnullable.OptionalNullable[[components.UpdatePrivateEndpointRequestDeclaredRegion](../../models/components/updateprivateendpointrequestdeclaredregion.mdx)] | ➖ | Attest where this deployment processes data. | us | +| `DeclaredZdr` | optionalnullable.OptionalNullable[`bool`] | ➖ | Attest that this deployment retains no prompt or completion data. | | +| `UpstreamModelID` | `string` | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/components/updatescimgroupmappingrequest.mdx b/docs/models/components/updatescimgroupmappingrequest.mdx index 6f1bbda29..7f73f3770 100644 --- a/docs/models/components/updatescimgroupmappingrequest.mdx +++ b/docs/models/components/updatescimgroupmappingrequest.mdx @@ -6,4 +6,4 @@ title: "UpdateScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Role` | [components.UpdateScimGroupMappingRequestRole](../../models/components/updatescimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Role` | [components.UpdateScimGroupMappingRequestRole](../../models/components/updatescimgroupmappingrequestrole.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/updatescimgroupmappingresponse.mdx b/docs/models/components/updatescimgroupmappingresponse.mdx index 4e3c83a0d..7a421ef20 100644 --- a/docs/models/components/updatescimgroupmappingresponse.mdx +++ b/docs/models/components/updatescimgroupmappingresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateScimGroupMappingResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `Data` | [components.ScimGroupMapping](../../models/components/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/components/updateworkspacerequest.mdx b/docs/models/components/updateworkspacerequest.mdx index 0390b6896..071e304b5 100644 --- a/docs/models/components/updateworkspacerequest.mdx +++ b/docs/models/components/updateworkspacerequest.mdx @@ -6,15 +6,15 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New description for the workspace | Updated description | -| `DisabledServerTools` | optionalnullable.OptionalNullable[[][components.UpdateWorkspaceRequestDisabledServerTool](../../models/components/updateworkspacerequestdisabledservertool.mdx)] | :heavy_minus_sign: | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | -| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | -| `IoLoggingSamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `IsDataDiscountLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `IsObservabilityBroadcastEnabled` | `*bool` | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `IsObservabilityIoLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether private logging is enabled | false | -| `Name` | `*string` | :heavy_minus_sign: | New name for the workspace | Updated Workspace | -| `Slug` | `*string` | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file +| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Default image model for this workspace | openai/dall-e-3 | +| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | ➖ | Default text model for this workspace | openai/gpt-4o | +| `Description` | optionalnullable.OptionalNullable[`string`] | ➖ | New description for the workspace | Updated description | +| `DisabledServerTools` | optionalnullable.OptionalNullable[[][components.UpdateWorkspaceRequestDisabledServerTool](../../models/components/updateworkspacerequestdisabledservertool.mdx)] | ➖ | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | +| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | ➖ | Optional array of API key IDs to filter I/O logging | null | +| `IoLoggingSamplingRate` | `*float64` | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | +| `IsDataDiscountLoggingEnabled` | `*bool` | ➖ | Whether data discount logging is enabled | true | +| `IsObservabilityBroadcastEnabled` | `*bool` | ➖ | Whether broadcast is enabled | false | +| `IsObservabilityIoLoggingEnabled` | `*bool` | ➖ | Whether private logging is enabled | false | +| `Name` | `*string` | ➖ | New name for the workspace | Updated Workspace | +| `Slug` | `*string` | ➖ | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file diff --git a/docs/models/components/updateworkspaceresponse.mdx b/docs/models/components/updateworkspaceresponse.mdx index ff023e764..b62589512 100644 --- a/docs/models/components/updateworkspaceresponse.mdx +++ b/docs/models/components/updateworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateWorkspaceResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `Data` | [components.Workspace](../../models/components/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/components/upscalefactor.mdx b/docs/models/components/upscalefactor.mdx index 232a32a5c..6296326aa 100644 --- a/docs/models/components/upscalefactor.mdx +++ b/docs/models/components/upscalefactor.mdx @@ -9,5 +9,5 @@ Supported upscale factor range for video upscaling models | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `Max` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `Min` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Max` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | +| `Min` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/upsertworkspacebudgetrequest.mdx b/docs/models/components/upsertworkspacebudgetrequest.mdx index 738cc0513..677365333 100644 --- a/docs/models/components/upsertworkspacebudgetrequest.mdx +++ b/docs/models/components/upsertworkspacebudgetrequest.mdx @@ -6,5 +6,5 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether to include BYOK (bring-your-own-key) spend when enforcing the workspace's budgets. This is a workspace-wide setting: it applies to every budget interval (daily, weekly, monthly, and lifetime), not just the interval being upserted in this request. Omit to leave the current setting unchanged. | true | -| `LimitUsd` | `float64` | :heavy_check_mark: | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file +| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether to include BYOK (bring-your-own-key) spend when enforcing the workspace's budgets. This is a workspace-wide setting: it applies to every budget interval (daily, weekly, monthly, and lifetime), not just the interval being upserted in this request. Omit to leave the current setting unchanged. | true | +| `LimitUsd` | `float64` | ✅ | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file diff --git a/docs/models/components/upsertworkspacebudgetresponse.mdx b/docs/models/components/upsertworkspacebudgetresponse.mdx index 7535dc67f..de07de611 100644 --- a/docs/models/components/upsertworkspacebudgetresponse.mdx +++ b/docs/models/components/upsertworkspacebudgetresponse.mdx @@ -6,5 +6,5 @@ title: "UpsertWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file +| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file diff --git a/docs/models/components/upstream.mdx b/docs/models/components/upstream.mdx index ee7daa48f..a4edeaacb 100644 --- a/docs/models/components/upstream.mdx +++ b/docs/models/components/upstream.mdx @@ -9,5 +9,5 @@ The upstream batch deletion outcome; omitted when no provider was assigned. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Provider` | `string` | :heavy_check_mark: | The provider name stored on the batch. | OpenAI | -| `Status` | [components.BatchDeletionOutcome](../../models/components/batchdeletionoutcome.mdx) | :heavy_check_mark: | Outcome for one deletion target: `deleted` (removed), `unsupported` (the provider has no batch-delete API; supported file cleanup still runs), or `not_applicable` (the batch never reached that target). | deleted | \ No newline at end of file +| `Provider` | `string` | ✅ | The provider name stored on the batch. | OpenAI | +| `Status` | [components.BatchDeletionOutcome](../../models/components/batchdeletionoutcome.mdx) | ✅ | Outcome for one deletion target: `deleted` (removed), `unsupported` (the provider has no batch-delete API; supported file cleanup still runs), or `not_applicable` (the batch never reached that target). | deleted | \ No newline at end of file diff --git a/docs/models/components/urlcitation.mdx b/docs/models/components/urlcitation.mdx index 6ed77177b..6b4196055 100644 --- a/docs/models/components/urlcitation.mdx +++ b/docs/models/components/urlcitation.mdx @@ -6,9 +6,9 @@ title: "URLCitation" | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Content` | `*string` | :heavy_minus_sign: | N/A | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Title` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.URLCitationType](../../models/components/urlcitationtype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | `*string` | ➖ | N/A | +| `EndIndex` | `int64` | ✅ | N/A | +| `StartIndex` | `int64` | ✅ | N/A | +| `Title` | `string` | ✅ | N/A | +| `Type` | [components.URLCitationType](../../models/components/urlcitationtype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/usage.mdx b/docs/models/components/usage.mdx index 6b5bef783..bd8ad7e2c 100644 --- a/docs/models/components/usage.mdx +++ b/docs/models/components/usage.mdx @@ -6,12 +6,12 @@ title: "Usage" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `InputTokens` | `int64` | :heavy_check_mark: | N/A | | -| `InputTokensDetails` | [components.InputTokensDetails](../../models/components/inputtokensdetails.mdx) | :heavy_check_mark: | N/A | | -| `OutputTokens` | `int64` | :heavy_check_mark: | N/A | | -| `OutputTokensDetails` | [components.OutputTokensDetails](../../models/components/outputtokensdetails.mdx) | :heavy_check_mark: | N/A | | -| `TotalTokens` | `int64` | :heavy_check_mark: | N/A | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | [*components.UsageCostDetails](../../models/components/usagecostdetails.mdx) | :heavy_minus_sign: | N/A | | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | \ No newline at end of file +| `InputTokens` | `int64` | ✅ | N/A | | +| `InputTokensDetails` | [components.InputTokensDetails](../../models/components/inputtokensdetails.mdx) | ✅ | N/A | | +| `OutputTokens` | `int64` | ✅ | N/A | | +| `OutputTokensDetails` | [components.OutputTokensDetails](../../models/components/outputtokensdetails.mdx) | ✅ | N/A | | +| `TotalTokens` | `int64` | ✅ | N/A | | +| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Cost of the completion | | +| `CostDetails` | [*components.UsageCostDetails](../../models/components/usagecostdetails.mdx) | ➖ | N/A | | +| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails.mdx)] | ➖ | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | \ No newline at end of file diff --git a/docs/models/components/usagecostdetails.mdx b/docs/models/components/usagecostdetails.mdx index c4fbf92e2..24886368e 100644 --- a/docs/models/components/usagecostdetails.mdx +++ b/docs/models/components/usagecostdetails.mdx @@ -6,7 +6,7 @@ title: "UsageCostDetails" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ServerToolCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | -| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `UpstreamInferenceInputCost` | `float64` | :heavy_check_mark: | N/A | -| `UpstreamInferenceOutputCost` | `float64` | :heavy_check_mark: | N/A | \ No newline at end of file +| `ServerToolCost` | optionalnullable.OptionalNullable[`float64`] | ➖ | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | +| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | ➖ | N/A | +| `UpstreamInferenceInputCost` | `float64` | ✅ | N/A | +| `UpstreamInferenceOutputCost` | `float64` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/userlocation.mdx b/docs/models/components/userlocation.mdx index d066e2eb6..8152813e2 100644 --- a/docs/models/components/userlocation.mdx +++ b/docs/models/components/userlocation.mdx @@ -9,8 +9,8 @@ Approximate user location for location-biased search results. Passed through to | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.WebSearchPluginType](../../models/components/websearchplugintype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [components.WebSearchPluginType](../../models/components/websearchplugintype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/validateprivateendpointrequest.mdx b/docs/models/components/validateprivateendpointrequest.mdx index b83277f6d..af9fecb14 100644 --- a/docs/models/components/validateprivateendpointrequest.mdx +++ b/docs/models/components/validateprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "ValidatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `WorkspaceID` | `string` | :heavy_check_mark: | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `WorkspaceID` | `string` | ✅ | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/vaulteffectivesecret.mdx b/docs/models/components/vaulteffectivesecret.mdx index 626d95cc7..acb7483ec 100644 --- a/docs/models/components/vaulteffectivesecret.mdx +++ b/docs/models/components/vaulteffectivesecret.mdx @@ -9,8 +9,8 @@ Metadata for the one secret the intern's outbound requests receive under this na | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | -| `Fingerprint` | `*string` | :heavy_check_mark: | N/A | -| `Hosts` | []`string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Scope` | [components.VaultEffectiveSecretScope](../../models/components/vaulteffectivesecretscope.mdx) | :heavy_check_mark: | Where the delivered secret is stored: `intern` for the intern's own vault, `attached` for a vault attached to the intern, `workspace` for the workspace vault. | \ No newline at end of file +| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | N/A | +| `Fingerprint` | `*string` | ✅ | N/A | +| `Hosts` | []`string` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | +| `Scope` | [components.VaultEffectiveSecretScope](../../models/components/vaulteffectivesecretscope.mdx) | ✅ | Where the delivered secret is stored: `intern` for the intern's own vault, `attached` for a vault attached to the intern, `workspace` for the workspace vault. | \ No newline at end of file diff --git a/docs/models/components/vaulteffectivesecretlistresponse.mdx b/docs/models/components/vaulteffectivesecretlistresponse.mdx index 40ecb5981..e0bc39729 100644 --- a/docs/models/components/vaulteffectivesecretlistresponse.mdx +++ b/docs/models/components/vaulteffectivesecretlistresponse.mdx @@ -9,5 +9,5 @@ One page of the secrets an intern receives, one entry per name. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.VaultEffectiveSecret](../../models/components/vaulteffectivesecret.mdx) | :heavy_check_mark: | N/A | -| `HasMore` | `bool` | :heavy_check_mark: | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file +| `Data` | [][components.VaultEffectiveSecret](../../models/components/vaulteffectivesecret.mdx) | ✅ | N/A | +| `HasMore` | `bool` | ✅ | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file diff --git a/docs/models/components/vaultsecret.mdx b/docs/models/components/vaultsecret.mdx index 67332abd2..b374b4c22 100644 --- a/docs/models/components/vaultsecret.mdx +++ b/docs/models/components/vaultsecret.mdx @@ -9,7 +9,7 @@ Metadata for one stored secret. The secret value is never returned. `fingerprint | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | N/A | -| `Fingerprint` | `*string` | :heavy_check_mark: | N/A | -| `Hosts` | []`string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `CreatedAt` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | N/A | +| `Fingerprint` | `*string` | ✅ | N/A | +| `Hosts` | []`string` | ✅ | N/A | +| `Name` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/vaultsecretcopyrequest.mdx b/docs/models/components/vaultsecretcopyrequest.mdx index 9238ec19c..4b2e18e2a 100644 --- a/docs/models/components/vaultsecretcopyrequest.mdx +++ b/docs/models/components/vaultsecretcopyrequest.mdx @@ -9,4 +9,4 @@ Workspace secrets to copy into the intern scope. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Names` | []`string` | :heavy_check_mark: | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | \ No newline at end of file +| `Names` | []`string` | ✅ | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | \ No newline at end of file diff --git a/docs/models/components/vaultsecretcopyresponse.mdx b/docs/models/components/vaultsecretcopyresponse.mdx index 947fe3fd6..2b8f85062 100644 --- a/docs/models/components/vaultsecretcopyresponse.mdx +++ b/docs/models/components/vaultsecretcopyresponse.mdx @@ -9,4 +9,4 @@ Metadata for the copies now stored in the intern scope, one entry per requested | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Data` | [][components.VaultSecret](../../models/components/vaultsecret.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.VaultSecret](../../models/components/vaultsecret.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/vaultsecretlistresponse.mdx b/docs/models/components/vaultsecretlistresponse.mdx index eafe5927f..e954a6222 100644 --- a/docs/models/components/vaultsecretlistresponse.mdx +++ b/docs/models/components/vaultsecretlistresponse.mdx @@ -9,5 +9,5 @@ One page of secret metadata for the selected scope. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.VaultSecret](../../models/components/vaultsecret.mdx) | :heavy_check_mark: | N/A | -| `HasMore` | `bool` | :heavy_check_mark: | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file +| `Data` | [][components.VaultSecret](../../models/components/vaultsecret.mdx) | ✅ | N/A | +| `HasMore` | `bool` | ✅ | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file diff --git a/docs/models/components/vaultsecretresponse.mdx b/docs/models/components/vaultsecretresponse.mdx index 6517479a2..3bb2f25ce 100644 --- a/docs/models/components/vaultsecretresponse.mdx +++ b/docs/models/components/vaultsecretresponse.mdx @@ -9,4 +9,4 @@ Metadata for the stored secret. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.VaultSecret](../../models/components/vaultsecret.mdx) | :heavy_check_mark: | Metadata for one stored secret. The secret value is never returned. `fingerprint` is an HMAC-SHA-256 of the value keyed with that vault's own data key, so it is comparable only within one vault: equal fingerprints in one vault mean equal values, and rewriting the same value keeps its fingerprint. The same value stored in two vaults (for example a workspace secret and its intern copy) carries different fingerprints, so comparing fingerprints across vaults cannot show that a copy matches or that a rotation propagated. `hosts` and `fingerprint` are `null` only for legacy rows written before host binding was required; storing the secret again assigns hosts. | \{
"created_at": "2026-09-15T17:44:00.000Z",
"fingerprint": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"hosts": [
"api.github.com"
],
"name": "github_token"
} | \ No newline at end of file +| `Data` | [components.VaultSecret](../../models/components/vaultsecret.mdx) | ✅ | Metadata for one stored secret. The secret value is never returned. `fingerprint` is an HMAC-SHA-256 of the value keyed with that vault's own data key, so it is comparable only within one vault: equal fingerprints in one vault mean equal values, and rewriting the same value keeps its fingerprint. The same value stored in two vaults (for example a workspace secret and its intern copy) carries different fingerprints, so comparing fingerprints across vaults cannot show that a copy matches or that a rotation propagated. `hosts` and `fingerprint` are `null` only for legacy rows written before host binding was required; storing the secret again assigns hosts. | \{
"created_at": "2026-09-15T17:44:00.000Z",
"fingerprint": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"hosts": [
"api.github.com"
],
"name": "github_token"
} | \ No newline at end of file diff --git a/docs/models/components/vaultsecretwriterequest.mdx b/docs/models/components/vaultsecretwriterequest.mdx index 4e4f5b956..14e6c598b 100644 --- a/docs/models/components/vaultsecretwriterequest.mdx +++ b/docs/models/components/vaultsecretwriterequest.mdx @@ -9,5 +9,5 @@ Secret value and the exact hostnames it may be released to. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Hosts` | []`string` | :heavy_check_mark: | Exact DNS hostnames the secret may be sent to, 1 to 100 entries. Each entry is lowercased and a trailing dot is removed, so `API.Example.com.` is stored as `api.example.com`. Schemes, ports, paths, wildcards and empty values are rejected. Duplicates after normalization are collapsed. Matching is exact: a secret bound to `api.example.com` is never released to `example.com` or any other hostname. | -| `Value` | `string` | :heavy_check_mark: | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file +| `Hosts` | []`string` | ✅ | Exact DNS hostnames the secret may be sent to, 1 to 100 entries. Each entry is lowercased and a trailing dot is removed, so `API.Example.com.` is stored as `api.example.com`. Schemes, ports, paths, wildcards and empty values are rejected. Duplicates after normalization are collapsed. Matching is exact: a secret bound to `api.example.com` is never released to `example.com` or any other hostname. | +| `Value` | `string` | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file diff --git a/docs/models/components/videogeneration.mdx b/docs/models/components/videogeneration.mdx index 591742048..54ab7c7e4 100644 --- a/docs/models/components/videogeneration.mdx +++ b/docs/models/components/videogeneration.mdx @@ -6,6 +6,6 @@ title: "VideoGeneration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `RequestCount` | `*int64` | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `Latency` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `RequestCount` | `*int64` | ✅ | Total requests admitted for this workload in the window. | | +| `Throughput` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/components/videogenerationrequest.mdx b/docs/models/components/videogenerationrequest.mdx index a996eaa67..c9e768294 100644 --- a/docs/models/components/videogenerationrequest.mdx +++ b/docs/models/components/videogenerationrequest.mdx @@ -6,21 +6,21 @@ title: "VideoGenerationRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AspectRatio` | [*components.VideoGenerationRequestAspectRatio](../../models/components/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | -| `CallbackURL` | `*string` | :heavy_minus_sign: | URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS. | https://example.com/webhook | -| `Creativity` | `*int64` | :heavy_minus_sign: | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | -| `Duration` | `*int64` | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `FrameImages` | [][components.FrameImage](../../models/components/frameimage.mdx) | :heavy_minus_sign: | Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame. | | -| `GenerateAudio` | `*bool` | :heavy_minus_sign: | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | -| `InputReferences` | [][components.InputReference](../../models/components/inputreference.mdx) | :heavy_minus_sign: | Reference assets to guide video generation. Accepts image, audio, and video references. Audio and video references are only honored by providers that support them (including BytePlus Seedance generation 2 and newer); other providers use image references and ignore the rest. | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `PreviousJobID` | `*string` | :heavy_minus_sign: | ID of a completed video job to edit or extend, as returned by the submit response. The new job runs on the same model and endpoint that produced the previous one. Only models that support continuation accept this field. | gen-vid-1789493115-a1B2c3D4e5F6g7H8i9J0 | -| `Prompt` | `*string` | :heavy_minus_sign: | Text prompt describing the video to generate. Optional for models that support generating a video from image input alone; required by all other models. | A serene mountain landscape at sunset | -| `Provider` | [*components.VideoGenerationRequestProvider](../../models/components/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `Resolution` | [*components.VideoGenerationRequestResolution](../../models/components/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | -| `Seed` | `*int64` | :heavy_minus_sign: | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Size` | `*string` | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `UpscaleFactor` | `*float64` | :heavy_minus_sign: | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | -| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `AspectRatio` | [*components.VideoGenerationRequestAspectRatio](../../models/components/videogenerationrequestaspectratio.mdx) | ➖ | Aspect ratio of the generated video | 16:9 | +| `CallbackURL` | `*string` | ➖ | URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS. | https://example.com/webhook | +| `Creativity` | `*int64` | ➖ | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | +| `Duration` | `*int64` | ➖ | Duration of the generated video in seconds | 8 | +| `FrameImages` | [][components.FrameImage](../../models/components/frameimage.mdx) | ➖ | Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame. | | +| `GenerateAudio` | `*bool` | ➖ | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | +| `InputReferences` | [][components.InputReference](../../models/components/inputreference.mdx) | ➖ | Reference assets to guide video generation. Accepts image, audio, and video references. Audio and video references are only honored by providers that support them (including BytePlus Seedance generation 2 and newer); other providers use image references and ignore the rest. | | +| `Model` | `string` | ✅ | N/A | | +| `PreviousJobID` | `*string` | ➖ | ID of a completed video job to edit or extend, as returned by the submit response. The new job runs on the same model and endpoint that produced the previous one. Only models that support continuation accept this field. | gen-vid-1789493115-a1B2c3D4e5F6g7H8i9J0 | +| `Prompt` | `*string` | ➖ | Text prompt describing the video to generate. Optional for models that support generating a video from image input alone; required by all other models. | A serene mountain landscape at sunset | +| `Provider` | [*components.VideoGenerationRequestProvider](../../models/components/videogenerationrequestprovider.mdx) | ➖ | Provider-specific passthrough configuration | | +| `Resolution` | [*components.VideoGenerationRequestResolution](../../models/components/videogenerationrequestresolution.mdx) | ➖ | Resolution of the generated video | 720p | +| `Seed` | `*int64` | ➖ | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Size` | `*string` | ➖ | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `UpscaleFactor` | `*float64` | ➖ | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | +| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/components/videogenerationrequestoptions.mdx b/docs/models/components/videogenerationrequestoptions.mdx index a4dd8503e..0976a4cef 100644 --- a/docs/models/components/videogenerationrequestoptions.mdx +++ b/docs/models/components/videogenerationrequestoptions.mdx @@ -9,149 +9,149 @@ Provider-specific options keyed by provider slug. Only options for the matched p | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Oneai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ai21` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AionLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Akashml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Alibaba` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonBedrock` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonBedrockClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonNova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ambient` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anthropic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anthropic2` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anyscale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ArceeAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Assemblyai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AtlasCloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Atoma` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Avian` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Azure` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baidu` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baseten` | map[string]`any` | :heavy_minus_sign: | N/A | -| `BlackForestLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Byteplus` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Centml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cerebras` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Chutes` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cirrascale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Clarifai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ClaudeOnAws` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cloudflare` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cohere` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Coreweave` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cosine` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crofai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crucible` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crusoe` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Darkbloom` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Databricks` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Decart` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepgram` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepinfra` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepseek` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Dekallm` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Digitalocean` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Elevenlabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Enfer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `FakeProvider` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Featherless` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Fireworks` | map[string]`any` | :heavy_minus_sign: | N/A | -| `FishAudio` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Friendli` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gmicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleAiStudio` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleVertex` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gopomelo` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Groq` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Heygen` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Huggingface` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Hyperbolic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `HyperbolicQuantized` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inception` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `InferactVllm` | map[string]`any` | :heavy_minus_sign: | N/A | -| `InferenceNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Infermatic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inocloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `IoNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ionstream` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Klusterai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Krea` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lambda` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lepton` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Liquid` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lynn` | map[string]`any` | :heavy_minus_sign: | N/A | -| `LynnPrivate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Makora` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mancer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `MancerOld` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mara` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Meta` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Minimax` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mistral` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modelrun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modular` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Moonshotai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Morph` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ncompass` | map[string]`any` | :heavy_minus_sign: | N/A | -| `NearAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nebius` | map[string]`any` | :heavy_minus_sign: | N/A | -| `NexAgi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nextbit` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nineteen` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Novita` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nvidia` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Octoai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ollama` | map[string]`any` | :heavy_minus_sign: | N/A | -| `OpenInference` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Openai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Parasail` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perplexity` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Phala` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Poolside` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Primeintellect` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Quiver` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recraft` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recursal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reka` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Relace` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Replicate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Respan` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Runway` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SailResearch` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sakana` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SakanaAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sambanova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SambanovaCloaked` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Scaledown` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Seed` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SfCompute` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Siliconflow` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sourceful` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stealth` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stepfun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Streamlake` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Switchpoint` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Targon` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Tencent` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Tenstorrent` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Thinkingmachines` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Together` | map[string]`any` | :heavy_minus_sign: | N/A | -| `TogetherLite` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Typesafe` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ubicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Unbiased` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Upstage` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Venice` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Voyageai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Wafer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Wandb` | map[string]`any` | :heavy_minus_sign: | N/A | -| `WandbLegacy` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xiaomi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ZAi` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Oneai` | map[string]`any` | ➖ | N/A | +| `Ai21` | map[string]`any` | ➖ | N/A | +| `AionLabs` | map[string]`any` | ➖ | N/A | +| `Akashml` | map[string]`any` | ➖ | N/A | +| `Alibaba` | map[string]`any` | ➖ | N/A | +| `AmazonBedrock` | map[string]`any` | ➖ | N/A | +| `AmazonBedrockClaudeOnAws` | map[string]`any` | ➖ | N/A | +| `AmazonNova` | map[string]`any` | ➖ | N/A | +| `Ambient` | map[string]`any` | ➖ | N/A | +| `Anthropic` | map[string]`any` | ➖ | N/A | +| `Anthropic2` | map[string]`any` | ➖ | N/A | +| `Anyscale` | map[string]`any` | ➖ | N/A | +| `ArceeAi` | map[string]`any` | ➖ | N/A | +| `Assemblyai` | map[string]`any` | ➖ | N/A | +| `AtlasCloud` | map[string]`any` | ➖ | N/A | +| `Atoma` | map[string]`any` | ➖ | N/A | +| `Avian` | map[string]`any` | ➖ | N/A | +| `Azure` | map[string]`any` | ➖ | N/A | +| `Baidu` | map[string]`any` | ➖ | N/A | +| `Baseten` | map[string]`any` | ➖ | N/A | +| `BlackForestLabs` | map[string]`any` | ➖ | N/A | +| `Byteplus` | map[string]`any` | ➖ | N/A | +| `Centml` | map[string]`any` | ➖ | N/A | +| `Cerebras` | map[string]`any` | ➖ | N/A | +| `Chutes` | map[string]`any` | ➖ | N/A | +| `Cirrascale` | map[string]`any` | ➖ | N/A | +| `Clarifai` | map[string]`any` | ➖ | N/A | +| `ClaudeOnAws` | map[string]`any` | ➖ | N/A | +| `Cloudflare` | map[string]`any` | ➖ | N/A | +| `Cohere` | map[string]`any` | ➖ | N/A | +| `Coreweave` | map[string]`any` | ➖ | N/A | +| `Cosine` | map[string]`any` | ➖ | N/A | +| `Crofai` | map[string]`any` | ➖ | N/A | +| `Crucible` | map[string]`any` | ➖ | N/A | +| `Crusoe` | map[string]`any` | ➖ | N/A | +| `Darkbloom` | map[string]`any` | ➖ | N/A | +| `Databricks` | map[string]`any` | ➖ | N/A | +| `Decart` | map[string]`any` | ➖ | N/A | +| `Deepgram` | map[string]`any` | ➖ | N/A | +| `Deepinfra` | map[string]`any` | ➖ | N/A | +| `Deepseek` | map[string]`any` | ➖ | N/A | +| `Dekallm` | map[string]`any` | ➖ | N/A | +| `Digitalocean` | map[string]`any` | ➖ | N/A | +| `Elevenlabs` | map[string]`any` | ➖ | N/A | +| `Enfer` | map[string]`any` | ➖ | N/A | +| `FakeProvider` | map[string]`any` | ➖ | N/A | +| `Featherless` | map[string]`any` | ➖ | N/A | +| `Fireworks` | map[string]`any` | ➖ | N/A | +| `FishAudio` | map[string]`any` | ➖ | N/A | +| `Friendli` | map[string]`any` | ➖ | N/A | +| `Gmicloud` | map[string]`any` | ➖ | N/A | +| `GoogleAiStudio` | map[string]`any` | ➖ | N/A | +| `GoogleVertex` | map[string]`any` | ➖ | N/A | +| `Gopomelo` | map[string]`any` | ➖ | N/A | +| `Groq` | map[string]`any` | ➖ | N/A | +| `Heygen` | map[string]`any` | ➖ | N/A | +| `Huggingface` | map[string]`any` | ➖ | N/A | +| `Hyperbolic` | map[string]`any` | ➖ | N/A | +| `HyperbolicQuantized` | map[string]`any` | ➖ | N/A | +| `Inception` | map[string]`any` | ➖ | N/A | +| `Inceptron` | map[string]`any` | ➖ | N/A | +| `InferactVllm` | map[string]`any` | ➖ | N/A | +| `InferenceNet` | map[string]`any` | ➖ | N/A | +| `Infermatic` | map[string]`any` | ➖ | N/A | +| `Inflection` | map[string]`any` | ➖ | N/A | +| `Inocloud` | map[string]`any` | ➖ | N/A | +| `IoNet` | map[string]`any` | ➖ | N/A | +| `Ionstream` | map[string]`any` | ➖ | N/A | +| `Klusterai` | map[string]`any` | ➖ | N/A | +| `Krea` | map[string]`any` | ➖ | N/A | +| `Lambda` | map[string]`any` | ➖ | N/A | +| `Lepton` | map[string]`any` | ➖ | N/A | +| `Liquid` | map[string]`any` | ➖ | N/A | +| `Lynn` | map[string]`any` | ➖ | N/A | +| `LynnPrivate` | map[string]`any` | ➖ | N/A | +| `Makora` | map[string]`any` | ➖ | N/A | +| `Mancer` | map[string]`any` | ➖ | N/A | +| `MancerOld` | map[string]`any` | ➖ | N/A | +| `Mara` | map[string]`any` | ➖ | N/A | +| `Meta` | map[string]`any` | ➖ | N/A | +| `Minimax` | map[string]`any` | ➖ | N/A | +| `Mistral` | map[string]`any` | ➖ | N/A | +| `Modal` | map[string]`any` | ➖ | N/A | +| `Modelrun` | map[string]`any` | ➖ | N/A | +| `Modular` | map[string]`any` | ➖ | N/A | +| `Moonshotai` | map[string]`any` | ➖ | N/A | +| `Morph` | map[string]`any` | ➖ | N/A | +| `Ncompass` | map[string]`any` | ➖ | N/A | +| `NearAi` | map[string]`any` | ➖ | N/A | +| `Nebius` | map[string]`any` | ➖ | N/A | +| `NexAgi` | map[string]`any` | ➖ | N/A | +| `Nextbit` | map[string]`any` | ➖ | N/A | +| `Nineteen` | map[string]`any` | ➖ | N/A | +| `Novita` | map[string]`any` | ➖ | N/A | +| `Nvidia` | map[string]`any` | ➖ | N/A | +| `Octoai` | map[string]`any` | ➖ | N/A | +| `Ollama` | map[string]`any` | ➖ | N/A | +| `OpenInference` | map[string]`any` | ➖ | N/A | +| `Openai` | map[string]`any` | ➖ | N/A | +| `Parasail` | map[string]`any` | ➖ | N/A | +| `Perceptron` | map[string]`any` | ➖ | N/A | +| `Perplexity` | map[string]`any` | ➖ | N/A | +| `Phala` | map[string]`any` | ➖ | N/A | +| `Poolside` | map[string]`any` | ➖ | N/A | +| `Primeintellect` | map[string]`any` | ➖ | N/A | +| `Quiver` | map[string]`any` | ➖ | N/A | +| `Recraft` | map[string]`any` | ➖ | N/A | +| `Recursal` | map[string]`any` | ➖ | N/A | +| `Reflection` | map[string]`any` | ➖ | N/A | +| `Reka` | map[string]`any` | ➖ | N/A | +| `Relace` | map[string]`any` | ➖ | N/A | +| `Replicate` | map[string]`any` | ➖ | N/A | +| `Respan` | map[string]`any` | ➖ | N/A | +| `Runway` | map[string]`any` | ➖ | N/A | +| `SailResearch` | map[string]`any` | ➖ | N/A | +| `Sakana` | map[string]`any` | ➖ | N/A | +| `SakanaAi` | map[string]`any` | ➖ | N/A | +| `Sambanova` | map[string]`any` | ➖ | N/A | +| `SambanovaCloaked` | map[string]`any` | ➖ | N/A | +| `Scaledown` | map[string]`any` | ➖ | N/A | +| `Seed` | map[string]`any` | ➖ | N/A | +| `SfCompute` | map[string]`any` | ➖ | N/A | +| `Siliconflow` | map[string]`any` | ➖ | N/A | +| `Sourceful` | map[string]`any` | ➖ | N/A | +| `Stealth` | map[string]`any` | ➖ | N/A | +| `Stepfun` | map[string]`any` | ➖ | N/A | +| `Streamlake` | map[string]`any` | ➖ | N/A | +| `Switchpoint` | map[string]`any` | ➖ | N/A | +| `Targon` | map[string]`any` | ➖ | N/A | +| `Tencent` | map[string]`any` | ➖ | N/A | +| `Tenstorrent` | map[string]`any` | ➖ | N/A | +| `Thinkingmachines` | map[string]`any` | ➖ | N/A | +| `Together` | map[string]`any` | ➖ | N/A | +| `TogetherLite` | map[string]`any` | ➖ | N/A | +| `Typesafe` | map[string]`any` | ➖ | N/A | +| `Ubicloud` | map[string]`any` | ➖ | N/A | +| `Unbiased` | map[string]`any` | ➖ | N/A | +| `Upstage` | map[string]`any` | ➖ | N/A | +| `Venice` | map[string]`any` | ➖ | N/A | +| `Voyageai` | map[string]`any` | ➖ | N/A | +| `Wafer` | map[string]`any` | ➖ | N/A | +| `Wandb` | map[string]`any` | ➖ | N/A | +| `WandbLegacy` | map[string]`any` | ➖ | N/A | +| `Xai` | map[string]`any` | ➖ | N/A | +| `Xiaomi` | map[string]`any` | ➖ | N/A | +| `ZAi` | map[string]`any` | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/videogenerationrequestprovider.mdx b/docs/models/components/videogenerationrequestprovider.mdx index aab1e7556..0ea53fd15 100644 --- a/docs/models/components/videogenerationrequestprovider.mdx +++ b/docs/models/components/videogenerationrequestprovider.mdx @@ -9,4 +9,4 @@ Provider-specific passthrough configuration | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Options` | [*components.VideoGenerationRequestOptions](../../models/components/videogenerationrequestoptions.mdx) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file +| `Options` | [*components.VideoGenerationRequestOptions](../../models/components/videogenerationrequestoptions.mdx) | ➖ | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file diff --git a/docs/models/components/videogenerationresponse.mdx b/docs/models/components/videogenerationresponse.mdx index 00475f351..dc11d818c 100644 --- a/docs/models/components/videogenerationresponse.mdx +++ b/docs/models/components/videogenerationresponse.mdx @@ -6,10 +6,10 @@ title: "VideoGenerationResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Error` | `*string` | :heavy_minus_sign: | N/A | | -| `GenerationID` | `*string` | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | -| `ID` | `string` | :heavy_check_mark: | The video job ID, in the `gen-vid--<20 alphanumerics>` generation ID format. Pass it as `previous_job_id` to continue the generation. | | -| `PollingURL` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.VideoGenerationResponseStatus](../../models/components/videogenerationresponsestatus.mdx) | :heavy_check_mark: | N/A | | -| `UnsignedUrls` | []`string` | :heavy_minus_sign: | N/A | | -| `Usage` | [*components.VideoGenerationUsage](../../models/components/videogenerationusage.mdx) | :heavy_minus_sign: | Usage and cost information for the video generation. Available once the job has completed. | \{
"cost": 0.5,
"is_byok": false
} | \ No newline at end of file +| `Error` | `*string` | ➖ | N/A | | +| `GenerationID` | `*string` | ➖ | The generation ID associated with this video generation job. Available once the job has been processed. | | +| `ID` | `string` | ✅ | The video job ID, in the `gen-vid--<20 alphanumerics>` generation ID format. Pass it as `previous_job_id` to continue the generation. | | +| `PollingURL` | `string` | ✅ | N/A | | +| `Status` | [components.VideoGenerationResponseStatus](../../models/components/videogenerationresponsestatus.mdx) | ✅ | N/A | | +| `UnsignedUrls` | []`string` | ➖ | N/A | | +| `Usage` | [*components.VideoGenerationUsage](../../models/components/videogenerationusage.mdx) | ➖ | Usage and cost information for the video generation. Available once the job has completed. | \{
"cost": 0.5,
"is_byok": false
} | \ No newline at end of file diff --git a/docs/models/components/videogenerationusage.mdx b/docs/models/components/videogenerationusage.mdx index 3b380a8ac..8afc1d1af 100644 --- a/docs/models/components/videogenerationusage.mdx +++ b/docs/models/components/videogenerationusage.mdx @@ -9,5 +9,5 @@ Usage and cost information for the video generation. Available once the job has | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | The cost of the video generation in USD. | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file +| `Cost` | optionalnullable.OptionalNullable[`float64`] | ➖ | The cost of the video generation in USD. | +| `IsBYOK` | `*bool` | ➖ | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file diff --git a/docs/models/components/videomodel.mdx b/docs/models/components/videomodel.mdx index 1015c9157..4bf306d18 100644 --- a/docs/models/components/videomodel.mdx +++ b/docs/models/components/videomodel.mdx @@ -6,20 +6,20 @@ title: "VideoModel" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `AllowedPassthroughParameters` | []`string` | :heavy_check_mark: | List of parameters that are allowed to be passed through to the provider | | -| `CanonicalSlug` | `string` | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `Creativity` | []`int64` | :heavy_check_mark: | Supported creativity levels for video upscaling models | | -| `Description` | `*string` | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `GenerateAudio` | `*bool` | :heavy_check_mark: | Whether the model supports generating audio alongside video | | -| `HuggingFaceID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `Name` | `string` | :heavy_check_mark: | Display name of the model | GPT-4 | -| `PricingSkus` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | -| `Seed` | `*bool` | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | -| `SupportedAspectRatios` | [][components.SupportedAspectRatio](../../models/components/supportedaspectratio.mdx) | :heavy_check_mark: | Supported output aspect ratios | | -| `SupportedDurations` | []`int64` | :heavy_check_mark: | Supported video durations in seconds | | -| `SupportedFrameImages` | [][components.SupportedFrameImage](../../models/components/supportedframeimage.mdx) | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | -| `SupportedResolutions` | [][components.SupportedResolution](../../models/components/supportedresolution.mdx) | :heavy_check_mark: | Supported output resolutions | | -| `SupportedSizes` | [][components.SupportedSize](../../models/components/supportedsize.mdx) | :heavy_check_mark: | Supported output sizes (width x height) | | -| `UpscaleFactor` | [*components.UpscaleFactor](../../models/components/upscalefactor.mdx) | :heavy_check_mark: | Supported upscale factor range for video upscaling models | | \ No newline at end of file +| `AllowedPassthroughParameters` | []`string` | ✅ | List of parameters that are allowed to be passed through to the provider | | +| `CanonicalSlug` | `string` | ✅ | Canonical slug for the model | openai/gpt-4 | +| `Created` | `int64` | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `Creativity` | []`int64` | ✅ | Supported creativity levels for video upscaling models | | +| `Description` | `*string` | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `GenerateAudio` | `*bool` | ✅ | Whether the model supports generating audio alongside video | | +| `HuggingFaceID` | optionalnullable.OptionalNullable[`string`] | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `ID` | `string` | ✅ | Unique identifier for the model | openai/gpt-4 | +| `Name` | `string` | ✅ | Display name of the model | GPT-4 | +| `PricingSkus` | optionalnullable.OptionalNullable[map[string]`string`] | ➖ | Pricing SKUs with provider prefix stripped, values as strings | | +| `Seed` | `*bool` | ✅ | Whether the model supports deterministic generation via seed parameter | | +| `SupportedAspectRatios` | [][components.SupportedAspectRatio](../../models/components/supportedaspectratio.mdx) | ✅ | Supported output aspect ratios | | +| `SupportedDurations` | []`int64` | ✅ | Supported video durations in seconds | | +| `SupportedFrameImages` | [][components.SupportedFrameImage](../../models/components/supportedframeimage.mdx) | ✅ | Supported frame image types (e.g. first_frame, last_frame) | | +| `SupportedResolutions` | [][components.SupportedResolution](../../models/components/supportedresolution.mdx) | ✅ | Supported output resolutions | | +| `SupportedSizes` | [][components.SupportedSize](../../models/components/supportedsize.mdx) | ✅ | Supported output sizes (width x height) | | +| `UpscaleFactor` | [*components.UpscaleFactor](../../models/components/upscalefactor.mdx) | ✅ | Supported upscale factor range for video upscaling models | | \ No newline at end of file diff --git a/docs/models/components/videomodelslistresponse.mdx b/docs/models/components/videomodelslistresponse.mdx index de05095d7..c42abae72 100644 --- a/docs/models/components/videomodelslistresponse.mdx +++ b/docs/models/components/videomodelslistresponse.mdx @@ -6,4 +6,4 @@ title: "VideoModelsListResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Data` | [][components.VideoModel](../../models/components/videomodel.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.VideoModel](../../models/components/videomodel.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/videourl.mdx b/docs/models/components/videourl.mdx index 635d4df44..727ca30ff 100644 --- a/docs/models/components/videourl.mdx +++ b/docs/models/components/videourl.mdx @@ -6,4 +6,4 @@ title: "VideoURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/webfetchplugin.mdx b/docs/models/components/webfetchplugin.mdx index da53f8690..d15f84f02 100644 --- a/docs/models/components/webfetchplugin.mdx +++ b/docs/models/components/webfetchplugin.mdx @@ -6,8 +6,8 @@ title: "WebFetchPlugin" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Only fetch from these domains. | -| `BlockedDomains` | []`string` | :heavy_minus_sign: | Never fetch from these domains. | -| `ID` | [components.WebFetchPluginID](../../models/components/webfetchpluginid.mdx) | :heavy_check_mark: | N/A | -| `MaxContentTokens` | `*int64` | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file +| `AllowedDomains` | []`string` | ➖ | Only fetch from these domains. | +| `BlockedDomains` | []`string` | ➖ | Never fetch from these domains. | +| `ID` | [components.WebFetchPluginID](../../models/components/webfetchpluginid.mdx) | ✅ | N/A | +| `MaxContentTokens` | `*int64` | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | +| `MaxUses` | `*int64` | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file diff --git a/docs/models/components/webfetchservertool.mdx b/docs/models/components/webfetchservertool.mdx index af9313472..4291be9d7 100644 --- a/docs/models/components/webfetchservertool.mdx +++ b/docs/models/components/webfetchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: fetches full content from a URL (web page or PD | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.WebFetchServerToolConfig](../../models/components/webfetchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | -| `Type` | [components.WebFetchServerToolType](../../models/components/webfetchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebFetchServerToolConfig](../../models/components/webfetchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | +| `Type` | [components.WebFetchServerToolType](../../models/components/webfetchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/webfetchservertoolconfig.mdx b/docs/models/components/webfetchservertoolconfig.mdx index 34e1d4799..07f84a177 100644 --- a/docs/models/components/webfetchservertoolconfig.mdx +++ b/docs/models/components/webfetchservertoolconfig.mdx @@ -9,8 +9,8 @@ Configuration for the openrouter:web_fetch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Only fetch from these domains. | | -| `BlockedDomains` | []`string` | :heavy_minus_sign: | Never fetch from these domains. | | -| `Engine` | [*components.WebFetchEngineEnum](../../models/components/webfetchengineenum.mdx) | :heavy_minus_sign: | Which fetch engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in fetch. "exa" uses Exa Contents API. "openrouter" uses direct HTTP fetch. "firecrawl" uses Firecrawl scrape (requires BYOK). "parallel" uses the Parallel extract API. | auto | -| `MaxContentTokens` | `*int64` | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file +| `AllowedDomains` | []`string` | ➖ | Only fetch from these domains. | | +| `BlockedDomains` | []`string` | ➖ | Never fetch from these domains. | | +| `Engine` | [*components.WebFetchEngineEnum](../../models/components/webfetchengineenum.mdx) | ➖ | Which fetch engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in fetch. "exa" uses Exa Contents API. "openrouter" uses direct HTTP fetch. "firecrawl" uses Firecrawl scrape (requires BYOK). "parallel" uses the Parallel extract API. | auto | +| `MaxContentTokens` | `*int64` | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | +| `MaxUses` | `*int64` | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file diff --git a/docs/models/components/websearchcallcompletedevent.mdx b/docs/models/components/websearchcallcompletedevent.mdx index 22397fcaa..213ce0088 100644 --- a/docs/models/components/websearchcallcompletedevent.mdx +++ b/docs/models/components/websearchcallcompletedevent.mdx @@ -9,7 +9,7 @@ Web search call completed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallCompletedEventType](../../models/components/websearchcallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.WebSearchCallCompletedEventType](../../models/components/websearchcallcompletedeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchcallinprogressevent.mdx b/docs/models/components/websearchcallinprogressevent.mdx index 6a868ad82..5d165e16b 100644 --- a/docs/models/components/websearchcallinprogressevent.mdx +++ b/docs/models/components/websearchcallinprogressevent.mdx @@ -9,7 +9,7 @@ Web search call in progress | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallInProgressEventType](../../models/components/websearchcallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.WebSearchCallInProgressEventType](../../models/components/websearchcallinprogresseventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchcallsearchingevent.mdx b/docs/models/components/websearchcallsearchingevent.mdx index 7f16925af..b25f8f8a9 100644 --- a/docs/models/components/websearchcallsearchingevent.mdx +++ b/docs/models/components/websearchcallsearchingevent.mdx @@ -9,7 +9,7 @@ Web search call is searching | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallSearchingEventType](../../models/components/websearchcallsearchingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ItemID` | `string` | ✅ | N/A | +| `OutputIndex` | `int64` | ✅ | N/A | +| `SequenceNumber` | `int64` | ✅ | N/A | +| `Type` | [components.WebSearchCallSearchingEventType](../../models/components/websearchcallsearchingeventtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchcitation.mdx b/docs/models/components/websearchcitation.mdx index 314dcb0d8..fb7e80324 100644 --- a/docs/models/components/websearchcitation.mdx +++ b/docs/models/components/websearchcitation.mdx @@ -6,7 +6,7 @@ title: "WebSearchCitation" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `CitedText` | `*string` | :heavy_minus_sign: | N/A | -| `EncryptedIndex` | `*string` | :heavy_minus_sign: | N/A | -| `Title` | `*string` | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `CitedText` | `*string` | ➖ | N/A | +| `EncryptedIndex` | `*string` | ➖ | N/A | +| `Title` | `*string` | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchconfig.mdx b/docs/models/components/websearchconfig.mdx index c7cbb1681..90b6588d1 100644 --- a/docs/models/components/websearchconfig.mdx +++ b/docs/models/components/websearchconfig.mdx @@ -6,14 +6,14 @@ title: "WebSearchConfig" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `MaxCharacters` | `*int64` | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxTotalResults` | `*int64` | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `AllowedDomains` | []`string` | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `ExcludedDomains` | []`string` | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `MaxCharacters` | `*int64` | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxTotalResults` | `*int64` | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/websearchdomainfilter.mdx b/docs/models/components/websearchdomainfilter.mdx index a680c4452..a9eddd763 100644 --- a/docs/models/components/websearchdomainfilter.mdx +++ b/docs/models/components/websearchdomainfilter.mdx @@ -6,6 +6,6 @@ title: "WebSearchDomainFilter" | Field | Type | Required | Description | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | -| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | -| `ExcludedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | +| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | +| `ExcludedDomains` | optionalnullable.OptionalNullable[[]`string`] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchplugin.mdx b/docs/models/components/websearchplugin.mdx index fbf34f9d7..2acce8575 100644 --- a/docs/models/components/websearchplugin.mdx +++ b/docs/models/components/websearchplugin.mdx @@ -6,14 +6,14 @@ title: "WebSearchPlugin" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `Engine` | [*components.WebSearchEngine](../../models/components/websearchengine.mdx) | :heavy_minus_sign: | The search engine to use for web search. | exa | -| `ExcludeDomains` | []`string` | :heavy_minus_sign: | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | -| `ID` | [components.WebSearchPluginID](../../models/components/websearchpluginid.mdx) | :heavy_check_mark: | N/A | | -| `IncludeDomains` | []`string` | :heavy_minus_sign: | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | -| `MaxResults` | `*int64` | :heavy_minus_sign: | N/A | | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic). | | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchPrompt` | `*string` | :heavy_minus_sign: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.UserLocation](../../models/components/userlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Enabled` | `*bool` | ➖ | Set to false to disable the web-search plugin for this request. Defaults to true. | | +| `Engine` | [*components.WebSearchEngine](../../models/components/websearchengine.mdx) | ➖ | The search engine to use for web search. | exa | +| `ExcludeDomains` | []`string` | ➖ | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | +| `ID` | [components.WebSearchPluginID](../../models/components/websearchpluginid.mdx) | ✅ | N/A | | +| `IncludeDomains` | []`string` | ➖ | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | +| `MaxResults` | `*int64` | ➖ | N/A | | +| `MaxUses` | `*int64` | ➖ | Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic). | | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchPrompt` | `*string` | ➖ | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.UserLocation](../../models/components/userlocation.mdx)] | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/websearchservertool.mdx b/docs/models/components/websearchservertool.mdx index 32f65540f..a465fa1b1 100644 --- a/docs/models/components/websearchservertool.mdx +++ b/docs/models/components/websearchservertool.mdx @@ -9,12 +9,12 @@ Web search tool configuration (2025-08-26 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.WebSearchServerToolType](../../models/components/websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `Type` | [components.WebSearchServerToolType](../../models/components/websearchservertooltype.mdx) | ✅ | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/websearchservertoolconfig.mdx b/docs/models/components/websearchservertoolconfig.mdx index 940c89976..70cb4c164 100644 --- a/docs/models/components/websearchservertoolconfig.mdx +++ b/docs/models/components/websearchservertoolconfig.mdx @@ -9,14 +9,14 @@ Configuration for the openrouter:web_search server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `MaxCharacters` | `*int64` | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `MaxTotalResults` | `*int64` | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `MaxUses` | `*int64` | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `AllowedDomains` | []`string` | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `ExcludedDomains` | []`string` | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `MaxCharacters` | `*int64` | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `MaxResults` | `*int64` | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `MaxTotalResults` | `*int64` | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `MaxUses` | `*int64` | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `Mode` | [*components.WebSearchMode](../../models/components/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `XSearch` | [*components.XSearchOptions](../../models/components/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/components/websearchservertoolopenrouter.mdx b/docs/models/components/websearchservertoolopenrouter.mdx index 45b54e513..d31e85bb5 100644 --- a/docs/models/components/websearchservertoolopenrouter.mdx +++ b/docs/models/components/websearchservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.WebSearchServerToolConfig](../../models/components/websearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `Type` | [components.WebSearchServerToolOpenRouterType](../../models/components/websearchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebSearchServerToolConfig](../../models/components/websearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `Type` | [components.WebSearchServerToolOpenRouterType](../../models/components/websearchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/components/websearchsource.mdx b/docs/models/components/websearchsource.mdx index 395f5a3ad..3074f01a2 100644 --- a/docs/models/components/websearchsource.mdx +++ b/docs/models/components/websearchsource.mdx @@ -6,5 +6,5 @@ title: "WebSearchSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.WebSearchSourceType](../../models/components/websearchsourcetype.mdx) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.WebSearchSourceType](../../models/components/websearchsourcetype.mdx) | ✅ | N/A | +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchuserlocation.mdx b/docs/models/components/websearchuserlocation.mdx index 272b63c16..81ec099b0 100644 --- a/docs/models/components/websearchuserlocation.mdx +++ b/docs/models/components/websearchuserlocation.mdx @@ -9,8 +9,8 @@ User location information for web search | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [*components.WebSearchUserLocationType](../../models/components/websearchuserlocationtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [*components.WebSearchUserLocationType](../../models/components/websearchuserlocationtype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchuserlocationservertool.mdx b/docs/models/components/websearchuserlocationservertool.mdx index a1e0de9e6..2fc519c0b 100644 --- a/docs/models/components/websearchuserlocationservertool.mdx +++ b/docs/models/components/websearchuserlocationservertool.mdx @@ -9,8 +9,8 @@ Approximate user location for location-biased results. | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [*components.WebSearchUserLocationServerToolType](../../models/components/websearchuserlocationservertooltype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `City` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Country` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Region` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Timezone` | optionalnullable.OptionalNullable[`string`] | ➖ | N/A | +| `Type` | [*components.WebSearchUserLocationServerToolType](../../models/components/websearchuserlocationservertooltype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/components/workspace.mdx b/docs/models/components/workspace.mdx index b1b975a5c..f1f9afd4c 100644 --- a/docs/models/components/workspace.mdx +++ b/docs/models/components/workspace.mdx @@ -6,21 +6,21 @@ title: "Workspace" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | -| `CreatedBy` | `*string` | :heavy_check_mark: | User ID of the workspace creator | user_abc123 | -| `DefaultGuardrailID` | `string` | :heavy_check_mark: | Deterministic ID derived from the workspace ID. The default guardrail is materialized when its configuration is first written. | 595d5849-7e86-51fd-a7c0-705c34e4afff | -| `DefaultImageModel` | `*string` | :heavy_check_mark: | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | `*string` | :heavy_check_mark: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | `*string` | :heavy_check_mark: | Default text model for this workspace | openai/gpt-4o | -| `Description` | `*string` | :heavy_check_mark: | Description of the workspace | Production environment workspace | -| `DisabledServerTools` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | OpenRouter server tools (e.g. openrouter:web_search) that requests in this workspace may not invoke. Null means no tools are disabled. | null | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | -| `IncludeBYOKInBudgets` | `*bool` | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend counts toward this workspace's budgets. Set it via the workspace budget endpoints. | false | -| `IoLoggingAPIKeyIds` | []`int64` | :heavy_check_mark: | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | -| `IoLoggingSamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | -| `IsDataDiscountLoggingEnabled` | `bool` | :heavy_check_mark: | Whether data discount logging is enabled for this workspace | true | -| `IsObservabilityBroadcastEnabled` | `bool` | :heavy_check_mark: | Whether broadcast is enabled for this workspace | false | -| `IsObservabilityIoLoggingEnabled` | `bool` | :heavy_check_mark: | Whether private logging is enabled for this workspace | false | -| `Name` | `string` | :heavy_check_mark: | Name of the workspace | Production | -| `Slug` | `string` | :heavy_check_mark: | URL-friendly slug for the workspace | production | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | +| `CreatedBy` | `*string` | ✅ | User ID of the workspace creator | user_abc123 | +| `DefaultGuardrailID` | `string` | ✅ | Deterministic ID derived from the workspace ID. The default guardrail is materialized when its configuration is first written. | 595d5849-7e86-51fd-a7c0-705c34e4afff | +| `DefaultImageModel` | `*string` | ✅ | Default image model for this workspace | openai/dall-e-3 | +| `DefaultProviderSort` | `*string` | ✅ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `DefaultTextModel` | `*string` | ✅ | Default text model for this workspace | openai/gpt-4o | +| `Description` | `*string` | ✅ | Description of the workspace | Production environment workspace | +| `DisabledServerTools` | optionalnullable.OptionalNullable[[]`string`] | ➖ | OpenRouter server tools (e.g. openrouter:web_search) that requests in this workspace may not invoke. Null means no tools are disabled. | null | +| `ID` | `string` | ✅ | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | +| `IncludeBYOKInBudgets` | `*bool` | ➖ | Whether BYOK (bring-your-own-key) spend counts toward this workspace's budgets. Set it via the workspace budget endpoints. | false | +| `IoLoggingAPIKeyIds` | []`int64` | ✅ | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | +| `IoLoggingSamplingRate` | `float64` | ✅ | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | +| `IsDataDiscountLoggingEnabled` | `bool` | ✅ | Whether data discount logging is enabled for this workspace | true | +| `IsObservabilityBroadcastEnabled` | `bool` | ✅ | Whether broadcast is enabled for this workspace | false | +| `IsObservabilityIoLoggingEnabled` | `bool` | ✅ | Whether private logging is enabled for this workspace | false | +| `Name` | `string` | ✅ | Name of the workspace | Production | +| `Slug` | `string` | ✅ | URL-friendly slug for the workspace | production | +| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/docs/models/components/workspacebudget.mdx b/docs/models/components/workspacebudget.mdx index 07bb06ed8..749e2a183 100644 --- a/docs/models/components/workspacebudget.mdx +++ b/docs/models/components/workspacebudget.mdx @@ -6,9 +6,9 @@ title: "WorkspaceBudget" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | -| `LimitUsd` | `float64` | :heavy_check_mark: | Spending limit in USD for this interval | 100 | -| `ResetInterval` | [*components.ResetInterval](../../models/components/resetinterval.mdx) | :heavy_check_mark: | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | -| `UpdatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | +| `ID` | `string` | ✅ | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | +| `LimitUsd` | `float64` | ✅ | Spending limit in USD for this interval | 100 | +| `ResetInterval` | [*components.ResetInterval](../../models/components/resetinterval.mdx) | ✅ | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | +| `UpdatedAt` | `string` | ✅ | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | +| `WorkspaceID` | `string` | ✅ | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/workspacemember.mdx b/docs/models/components/workspacemember.mdx index 1dcdc0b03..4dd2a99ec 100644 --- a/docs/models/components/workspacemember.mdx +++ b/docs/models/components/workspacemember.mdx @@ -6,8 +6,8 @@ title: "WorkspaceMember" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `Role` | [components.WorkspaceMemberRole](../../models/components/workspacememberrole.mdx) | :heavy_check_mark: | Role of the member in the workspace | member | -| `UserID` | `string` | :heavy_check_mark: | Clerk user ID of the member | user_abc123 | -| `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | +| `ID` | `string` | ✅ | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | +| `Role` | [components.WorkspaceMemberRole](../../models/components/workspacememberrole.mdx) | ✅ | Role of the member in the workspace | member | +| `UserID` | `string` | ✅ | Clerk user ID of the member | user_abc123 | +| `WorkspaceID` | `string` | ✅ | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/xsearchoptions.mdx b/docs/models/components/xsearchoptions.mdx index 4690aca2e..e3cfa306b 100644 --- a/docs/models/components/xsearchoptions.mdx +++ b/docs/models/components/xsearchoptions.mdx @@ -9,9 +9,9 @@ Enable SpaceXAI X (Twitter) search alongside native web search, with optional fi | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `AllowedXHandles` | []`string` | :heavy_minus_sign: | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | -| `EnableImageUnderstanding` | `*bool` | :heavy_minus_sign: | Analyze images attached to matching posts. | | -| `EnableVideoUnderstanding` | `*bool` | :heavy_minus_sign: | Analyze videos attached to matching posts. | | -| `ExcludedXHandles` | []`string` | :heavy_minus_sign: | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | -| `FromDate` | [*types.Date](../../types/date.mdx) | :heavy_minus_sign: | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | -| `ToDate` | [*types.Date](../../types/date.mdx) | :heavy_minus_sign: | End of the post date range (ISO 8601 date, e.g. "2025-12-31"). | 2025-12-31 | \ No newline at end of file +| `AllowedXHandles` | []`string` | ➖ | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | +| `EnableImageUnderstanding` | `*bool` | ➖ | Analyze images attached to matching posts. | | +| `EnableVideoUnderstanding` | `*bool` | ➖ | Analyze videos attached to matching posts. | | +| `ExcludedXHandles` | []`string` | ➖ | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | +| `FromDate` | [*types.Date](../../types/date.mdx) | ➖ | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | +| `ToDate` | [*types.Date](../../types/date.mdx) | ➖ | End of the post date range (ISO 8601 date, e.g. "2025-12-31"). | 2025-12-31 | \ No newline at end of file diff --git a/docs/models/operations/activateprivateendpointrequest.mdx b/docs/models/operations/activateprivateendpointrequest.mdx index d3f3d2551..b9a5d0a63 100644 --- a/docs/models/operations/activateprivateendpointrequest.mdx +++ b/docs/models/operations/activateprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "ActivatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/bulkaddworkspacemembersrequest.mdx b/docs/models/operations/bulkaddworkspacemembersrequest.mdx index c33d12a56..5d371843e 100644 --- a/docs/models/operations/bulkaddworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkaddworkspacemembersrequest.mdx @@ -6,5 +6,5 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `BulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `BulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx index 664f49096..9acbf7df7 100644 --- a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "BulkAssignKeysToGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `BulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx index fcaab1b76..fd35fa90d 100644 --- a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "BulkAssignMembersToGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `BulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx index 1333a3b4d..adbae1ccd 100644 --- a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx @@ -6,5 +6,5 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `BulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `BulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx index bc3a865a0..2807faf3a 100644 --- a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "BulkUnassignKeysFromGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `BulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx index 39f2fbf6a..1e96e9e3a 100644 --- a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "BulkUnassignMembersFromGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `BulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/classifierdimensions.mdx b/docs/models/operations/classifierdimensions.mdx index 6d7eb45a5..4068fadab 100644 --- a/docs/models/operations/classifierdimensions.mdx +++ b/docs/models/operations/classifierdimensions.mdx @@ -9,6 +9,6 @@ Group results by custom classifier tags, breaking down metrics by the specified | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `ClassifierID` | `string` | :heavy_check_mark: | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | -| `DimensionNames` | []`string` | :heavy_minus_sign: | N/A | | -| `IncludeNulls` | `*bool` | :heavy_minus_sign: | When true, also include generations that have no tag from this classifier. Defaults to false, which returns only classified generations. | | \ No newline at end of file +| `ClassifierID` | `string` | ✅ | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | +| `DimensionNames` | []`string` | ➖ | N/A | | +| `IncludeNulls` | `*bool` | ➖ | When true, also include generations that have no tag from this classifier. Defaults to false, which returns only classified generations. | | \ No newline at end of file diff --git a/docs/models/operations/classifierfilters.mdx b/docs/models/operations/classifierfilters.mdx index 27444c7ed..0674f9675 100644 --- a/docs/models/operations/classifierfilters.mdx +++ b/docs/models/operations/classifierfilters.mdx @@ -9,5 +9,5 @@ Filter results to generations with specific classifier tag values. Can be combin | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `ClassifierID` | `string` | :heavy_check_mark: | UUID of the classifier whose tags to filter by. Must match classifier_dimensions.classifier_id when both are specified. | 550e8400-e29b-41d4-a716-446655440000 | -| `Filters` | [][operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ClassifierID` | `string` | ✅ | UUID of the classifier whose tags to filter by. Must match classifier_dimensions.classifier_id when both are specified. | 550e8400-e29b-41d4-a716-446655440000 | +| `Filters` | [][operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/classifierfiltersfilter.mdx b/docs/models/operations/classifierfiltersfilter.mdx index 3e1d76509..0106c3657 100644 --- a/docs/models/operations/classifierfiltersfilter.mdx +++ b/docs/models/operations/classifierfiltersfilter.mdx @@ -6,6 +6,6 @@ title: "ClassifierFiltersFilter" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Field` | `string` | :heavy_check_mark: | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | -| `Operator` | `string` | :heavy_check_mark: | Filter operator. Only equality/set operators are supported (eq, neq, in, not_in) — ordered comparisons are not available because classification values are strings. | eq | -| `Value` | [operations.ClassifierFiltersValue](../../models/operations/classifierfiltersvalue.mdx) | :heavy_check_mark: | Filter value. Use a scalar (string or number) for eq/neq, or an array for in/not_in. | Engineering | \ No newline at end of file +| `Field` | `string` | ✅ | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | +| `Operator` | `string` | ✅ | Filter operator. Only equality/set operators are supported (eq, neq, in, not_in) — ordered comparisons are not available because classification values are strings. | eq | +| `Value` | [operations.ClassifierFiltersValue](../../models/operations/classifierfiltersvalue.mdx) | ✅ | Filter value. Use a scalar (string or number) for eq/neq, or an array for in/not_in. | Engineering | \ No newline at end of file diff --git a/docs/models/operations/contentimageurl.mdx b/docs/models/operations/contentimageurl.mdx index 316466ddd..f43e3442c 100644 --- a/docs/models/operations/contentimageurl.mdx +++ b/docs/models/operations/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ImageURL` | [operations.ImageURL](../../models/operations/imageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [operations.TypeImageURL](../../models/operations/typeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [operations.ImageURL](../../models/operations/imageurl.mdx) | ✅ | N/A | +| `Type` | [operations.TypeImageURL](../../models/operations/typeimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/contenttext.mdx b/docs/models/operations/contenttext.mdx index f9a90d0b5..24612167e 100644 --- a/docs/models/operations/contenttext.mdx +++ b/docs/models/operations/contenttext.mdx @@ -6,5 +6,5 @@ title: "ContentText" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [operations.TypeText](../../models/operations/typetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Text` | `string` | ✅ | N/A | +| `Type` | [operations.TypeText](../../models/operations/typetext.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/copyvaultsecretstointernrequest.mdx b/docs/models/operations/copyvaultsecretstointernrequest.mdx index 8b2f9564c..608363f43 100644 --- a/docs/models/operations/copyvaultsecretstointernrequest.mdx +++ b/docs/models/operations/copyvaultsecretstointernrequest.mdx @@ -6,5 +6,5 @@ title: "CopyVaultSecretsToInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `VaultSecretCopyRequest` | [components.VaultSecretCopyRequest](../../models/components/vaultsecretcopyrequest.mdx) | :heavy_check_mark: | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file +| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `VaultSecretCopyRequest` | [components.VaultSecretCopyRequest](../../models/components/vaultsecretcopyrequest.mdx) | ✅ | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx b/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx index 94daa49e5..98240e106 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx @@ -6,5 +6,5 @@ title: "CreateAudioTranscriptionsMultipartFile" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `FileName` | `string` | :heavy_check_mark: | N/A | -| `Content` | `any` | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileName` | `string` | ✅ | N/A | +| `Content` | `any` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx index 490eee090..fff4f6310 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx @@ -6,16 +6,16 @@ title: "CreateAudioTranscriptionsMultipartRequest" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Diarize` | `*bool` | :heavy_minus_sign: | Label each word with the speaker who said it (words[].speaker, words[].speaker_label). Requires response_format "verbose_json" (400 otherwise); word timestamps are included even when timestamp_granularities[] omits "word". Only supported by some providers; 400 when the selected model cannot diarize. | -| `File` | [*operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile.mdx) | :heavy_minus_sign: | The audio file to transcribe. The format is derived from the filename extension or the file part content type. Max 25 MB; send larger files as base64 JSON via input_audio, or by URL via source_url. Exactly one of file or source_url is required. | -| `Keyterms` | []`string` | :heavy_minus_sign: | Domain terms, names, or phrases to bias recognition toward; repeat the part once per term (keyterms=... is also accepted). Only supported by some providers; 400 when the selected model cannot use keyterms. | -| `Language` | `*string` | :heavy_minus_sign: | The language of the input audio (ISO-639-1). | -| `Model` | `string` | :heavy_check_mark: | The model to use for transcription. | -| `Provider` | `*string` | :heavy_minus_sign: | JSON-encoded provider preferences object, the same shape as the JSON body field: \{ "zdr": true, "data_collection": "deny", "options": \{ "\": \{ ... } } }. Only options for the matched provider are forwarded. Must decode to a JSON object. | -| `ResponseFormat` | [*operations.ResponseFormat](../../models/operations/responseformat.mdx) | :heavy_minus_sign: | The response format. "json" (default) returns \{ text, usage }; "verbose_json" additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only). | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. | -| `SourceURL` | `*string` | :heavy_minus_sign: | Publicly reachable http(s) URL of the audio file, downloaded by the provider directly (no size limit on our side). The format is derived from the URL path extension. Only supported by some providers; exactly one of file or source_url is required. | -| `Temperature` | `*float64` | :heavy_minus_sign: | The sampling temperature. | -| `TimestampGranularities` | [][operations.TimestampGranularities](../../models/operations/timestampgranularities.mdx) | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | -| `Trace` | `*string` | :heavy_minus_sign: | JSON-encoded trace metadata object (trace_id, trace_name, span_name, generation_name, parent_span_id and custom keys) attached to the Broadcast trace. Must decode to a JSON object. | -| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | \ No newline at end of file +| `Diarize` | `*bool` | ➖ | Label each word with the speaker who said it (words[].speaker, words[].speaker_label). Requires response_format "verbose_json" (400 otherwise); word timestamps are included even when timestamp_granularities[] omits "word". Only supported by some providers; 400 when the selected model cannot diarize. | +| `File` | [*operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile.mdx) | ➖ | The audio file to transcribe. The format is derived from the filename extension or the file part content type. Max 25 MB; send larger files as base64 JSON via input_audio, or by URL via source_url. Exactly one of file or source_url is required. | +| `Keyterms` | []`string` | ➖ | Domain terms, names, or phrases to bias recognition toward; repeat the part once per term (keyterms=... is also accepted). Only supported by some providers; 400 when the selected model cannot use keyterms. | +| `Language` | `*string` | ➖ | The language of the input audio (ISO-639-1). | +| `Model` | `string` | ✅ | The model to use for transcription. | +| `Provider` | `*string` | ➖ | JSON-encoded provider preferences object, the same shape as the JSON body field: \{ "zdr": true, "data_collection": "deny", "options": \{ "\": \{ ... } } }. Only options for the matched provider are forwarded. Must decode to a JSON object. | +| `ResponseFormat` | [*operations.ResponseFormat](../../models/operations/responseformat.mdx) | ➖ | The response format. "json" (default) returns \{ text, usage }; "verbose_json" additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only). | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. | +| `SourceURL` | `*string` | ➖ | Publicly reachable http(s) URL of the audio file, downloaded by the provider directly (no size limit on our side). The format is derived from the URL path extension. Only supported by some providers; exactly one of file or source_url is required. | +| `Temperature` | `*float64` | ➖ | The sampling temperature. | +| `TimestampGranularities` | [][operations.TimestampGranularities](../../models/operations/timestampgranularities.mdx) | ➖ | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | +| `Trace` | `*string` | ➖ | JSON-encoded trace metadata object (trace_id, trace_name, span_name, generation_name, parent_span_id and custom keys) attached to the Broadcast trace. Must decode to a JSON object. | +| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscodedata.mdx b/docs/models/operations/createauthkeyscodedata.mdx index 309d665be..26e35d493 100644 --- a/docs/models/operations/createauthkeyscodedata.mdx +++ b/docs/models/operations/createauthkeyscodedata.mdx @@ -9,6 +9,6 @@ Auth code data | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `AppID` | `int64` | :heavy_check_mark: | The application ID associated with this auth code | 12345 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | -| `ID` | `string` | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file +| `AppID` | `int64` | ✅ | The application ID associated with this auth code | 12345 | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | +| `ID` | `string` | ✅ | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderequest.mdx b/docs/models/operations/createauthkeyscoderequest.mdx index 4577c3334..f4148f67e 100644 --- a/docs/models/operations/createauthkeyscoderequest.mdx +++ b/docs/models/operations/createauthkeyscoderequest.mdx @@ -6,11 +6,11 @@ title: "CreateAuthKeysCodeRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallbackURL` | `string` | :heavy_check_mark: | The callback URL to redirect to after authorization. Supports https URLs and localhost/127.0.0.1 URLs on any port for local CLI tools. | https://myapp.com/auth/callback | -| `CodeChallenge` | `*string` | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `CodeChallengeMethod` | [*operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `KeyLabel` | `*string` | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `Limit` | `*float64` | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `UsageLimitType` | [*operations.UsageLimitType](../../models/operations/usagelimittype.mdx) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to associate the API key with | | \ No newline at end of file +| `CallbackURL` | `string` | ✅ | The callback URL to redirect to after authorization. Supports https URLs and localhost/127.0.0.1 URLs on any port for local CLI tools. | https://myapp.com/auth/callback | +| `CodeChallenge` | `*string` | ➖ | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | +| `CodeChallengeMethod` | [*operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `KeyLabel` | `*string` | ➖ | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | +| `Limit` | `*float64` | ➖ | Credit limit for the API key to be created | 100 | +| `UsageLimitType` | [*operations.UsageLimitType](../../models/operations/usagelimittype.mdx) | ➖ | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | +| `WorkspaceID` | `*string` | ➖ | Optional workspace ID to associate the API key with | | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderesponse.mdx b/docs/models/operations/createauthkeyscoderesponse.mdx index 90fd1b3fa..00dad49a4 100644 --- a/docs/models/operations/createauthkeyscoderesponse.mdx +++ b/docs/models/operations/createauthkeyscoderesponse.mdx @@ -9,4 +9,4 @@ Successfully created authorization code | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [operations.CreateAuthKeysCodeData](../../models/operations/createauthkeyscodedata.mdx) | :heavy_check_mark: | Auth code data | \{
"app_id": 12345,
"created_at": "2025-08-24T10:30:00Z",
"id": "auth_code_xyz789"
} | \ No newline at end of file +| `Data` | [operations.CreateAuthKeysCodeData](../../models/operations/createauthkeyscodedata.mdx) | ✅ | Auth code data | \{
"app_id": 12345,
"created_at": "2025-08-24T10:30:00Z",
"id": "auth_code_xyz789"
} | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsdata.mdx b/docs/models/operations/createembeddingsdata.mdx index 297e417ac..00829e7ae 100644 --- a/docs/models/operations/createembeddingsdata.mdx +++ b/docs/models/operations/createembeddingsdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Embedding` | [operations.Embedding](../../models/operations/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `Index` | `*int64` | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `Object` | [operations.ObjectEmbedding](../../models/operations/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Embedding` | [operations.Embedding](../../models/operations/embedding.mdx) | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `Index` | `*int64` | ➖ | Index of the embedding in the input list | 0 | +| `Object` | [operations.ObjectEmbedding](../../models/operations/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsrequest.mdx b/docs/models/operations/createembeddingsrequest.mdx index 2a36bede8..35dc4afba 100644 --- a/docs/models/operations/createembeddingsrequest.mdx +++ b/docs/models/operations/createembeddingsrequest.mdx @@ -9,12 +9,12 @@ Embeddings request input | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Dimensions` | `*int64` | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `EncodingFormat` | [*operations.EncodingFormat](../../models/operations/encodingformat.mdx) | :heavy_minus_sign: | The format of the output embeddings | float | -| `Input` | [operations.InputUnion](../../models/operations/inputunion.mdx) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `InputType` | `*string` | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | -| `Model` | `string` | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | \ No newline at end of file +| `Dimensions` | `*int64` | ➖ | The number of dimensions for the output embeddings | 1536 | +| `EncodingFormat` | [*operations.EncodingFormat](../../models/operations/encodingformat.mdx) | ➖ | The format of the output embeddings | float | +| `Input` | [operations.InputUnion](../../models/operations/inputunion.mdx) | ✅ | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | +| `InputType` | `*string` | ➖ | The type of input (e.g. search_query, search_document) | search_query | +| `Model` | `string` | ✅ | The model to use for embeddings | openai/text-embedding-3-small | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | ➖ | A unique identifier for the end-user | user-1234 | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsresponsebody.mdx b/docs/models/operations/createembeddingsresponsebody.mdx index 321bb0f0f..a6e0ecf32 100644 --- a/docs/models/operations/createembeddingsresponsebody.mdx +++ b/docs/models/operations/createembeddingsresponsebody.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Data` | [][operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata.mdx) | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `ID` | `*string` | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | -| `Model` | `string` | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | -| `Object` | [operations.Object](../../models/operations/object.mdx) | :heavy_check_mark: | N/A | | -| `Usage` | [*operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `Data` | [][operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata.mdx) | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `ID` | `*string` | ➖ | Unique identifier for the embeddings response | embd-1234567890 | +| `Model` | `string` | ✅ | The model used for embeddings | openai/text-embedding-3-small | +| `Object` | [operations.Object](../../models/operations/object.mdx) | ✅ | N/A | | +| `Usage` | [*operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsusage.mdx b/docs/models/operations/createembeddingsusage.mdx index 5cdc0579c..798597f81 100644 --- a/docs/models/operations/createembeddingsusage.mdx +++ b/docs/models/operations/createembeddingsusage.mdx @@ -9,9 +9,9 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `IsBYOK` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `PromptTokens` | `int64` | :heavy_check_mark: | Number of tokens in the input | 8 | -| `PromptTokensDetails` | [*operations.PromptTokensDetails](../../models/operations/prompttokensdetails.mdx) | :heavy_minus_sign: | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | -| `TotalTokens` | `int64` | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file +| `Cost` | `*float64` | ➖ | Cost of the request in credits | 0.0001 | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails.mdx)] | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `IsBYOK` | `*bool` | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `PromptTokens` | `int64` | ✅ | Number of tokens in the input | 8 | +| `PromptTokensDetails` | [*operations.PromptTokensDetails](../../models/operations/prompttokensdetails.mdx) | ➖ | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | +| `TotalTokens` | `int64` | ✅ | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/models/operations/createinternchatcompletionrequest.mdx b/docs/models/operations/createinternchatcompletionrequest.mdx index 5cf4d6608..4cee3b309 100644 --- a/docs/models/operations/createinternchatcompletionrequest.mdx +++ b/docs/models/operations/createinternchatcompletionrequest.mdx @@ -6,5 +6,5 @@ title: "CreateInternChatCompletionRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `InternChatCompletionRequest` | [components.InternChatCompletionRequest](../../models/components/internchatcompletionrequest.mdx) | :heavy_check_mark: | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | \ No newline at end of file +| `InternID` | `string` | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `InternChatCompletionRequest` | [components.InternChatCompletionRequest](../../models/components/internchatcompletionrequest.mdx) | ✅ | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | \ No newline at end of file diff --git a/docs/models/operations/createinternchatcompletionresponse.mdx b/docs/models/operations/createinternchatcompletionresponse.mdx index ae5d813fc..42ed28f51 100644 --- a/docs/models/operations/createinternchatcompletionresponse.mdx +++ b/docs/models/operations/createinternchatcompletionresponse.mdx @@ -6,5 +6,5 @@ title: "CreateInternChatCompletionResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | -| `Result` | [operations.CreateInternChatCompletionResponseResult](../../models/operations/createinternchatcompletionresponseresult.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Headers` | map[string][]`string` | ✅ | N/A | +| `Result` | [operations.CreateInternChatCompletionResponseResult](../../models/operations/createinternchatcompletionresponseresult.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createinternrequest.mdx b/docs/models/operations/createinternrequest.mdx index 812090510..43b7ae194 100644 --- a/docs/models/operations/createinternrequest.mdx +++ b/docs/models/operations/createinternrequest.mdx @@ -6,5 +6,5 @@ title: "CreateInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IdempotencyKey` | `*string` | :heavy_minus_sign: | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | -| `CreateInternRequest` | [components.CreateInternRequest](../../models/components/createinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | \ No newline at end of file +| `IdempotencyKey` | `*string` | ➖ | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | +| `CreateInternRequest` | [components.CreateInternRequest](../../models/components/createinternrequest.mdx) | ✅ | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | \ No newline at end of file diff --git a/docs/models/operations/createkeysdata.mdx b/docs/models/operations/createkeysdata.mdx index 4aaec927a..55c06bd83 100644 --- a/docs/models/operations/createkeysdata.mdx +++ b/docs/models/operations/createkeysdata.mdx @@ -9,26 +9,26 @@ The created API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `ExternalUser` | `*string` | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `Disabled` | `bool` | ✅ | Whether the API key is disabled | false | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `ExternalUser` | `*string` | ✅ | Partner's end-user identifier used for attribution. | null | +| `Hash` | `string` | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | +| `Name` | `string` | ✅ | Name of the API key | My Production Key | +| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `string` | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/createkeysrequest.mdx b/docs/models/operations/createkeysrequest.mdx index e0341964a..1080055c6 100644 --- a/docs/models/operations/createkeysrequest.mdx +++ b/docs/models/operations/createkeysrequest.mdx @@ -6,11 +6,11 @@ title: "CreateKeysRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatorUserID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `External` | [*operations.External](../../models/operations/external.mdx) | :heavy_minus_sign: | Optional partner-defined identity associated with the created API key. | | -| `IncludeBYOKInLimit` | `*bool` | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `Limit` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `LimitReset` | optionalnullable.OptionalNullable[[operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset.mdx)] | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | -| `Name` | `string` | :heavy_check_mark: | Name for the new API key | My New API Key | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `CreatorUserID` | optionalnullable.OptionalNullable[`string`] | ➖ | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `External` | [*operations.External](../../models/operations/external.mdx) | ➖ | Optional partner-defined identity associated with the created API key. | | +| `IncludeBYOKInLimit` | `*bool` | ➖ | Whether to include BYOK usage in the limit | true | +| `Limit` | optionalnullable.OptionalNullable[`float64`] | ➖ | Optional spending limit for the API key in USD | 50 | +| `LimitReset` | optionalnullable.OptionalNullable[[operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset.mdx)] | ➖ | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | +| `Name` | `string` | ✅ | Name for the new API key | My New API Key | +| `WorkspaceID` | `*string` | ➖ | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/createkeysresponse.mdx b/docs/models/operations/createkeysresponse.mdx index e35f6c24d..6d183d1db 100644 --- a/docs/models/operations/createkeysresponse.mdx +++ b/docs/models/operations/createkeysresponse.mdx @@ -9,5 +9,5 @@ API key created successfully | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [operations.CreateKeysData](../../models/operations/createkeysdata.mdx) | :heavy_check_mark: | The created API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | -| `Key` | `string` | :heavy_check_mark: | The actual API key string (only shown once) | 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 | \ No newline at end of file +| `Data` | [operations.CreateKeysData](../../models/operations/createkeysdata.mdx) | ✅ | The created API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | +| `Key` | `string` | ✅ | The actual API key string (only shown once) | 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 | \ No newline at end of file diff --git a/docs/models/operations/createpresetschatcompletionsrequest.mdx b/docs/models/operations/createpresetschatcompletionsrequest.mdx index 1d0cf03af..1c9d6fdc9 100644 --- a/docs/models/operations/createpresetschatcompletionsrequest.mdx +++ b/docs/models/operations/createpresetschatcompletionsrequest.mdx @@ -6,5 +6,5 @@ title: "CreatePresetsChatCompletionsRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file +| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetsmessagesrequest.mdx b/docs/models/operations/createpresetsmessagesrequest.mdx index 30d1a19bc..fb0a25627 100644 --- a/docs/models/operations/createpresetsmessagesrequest.mdx +++ b/docs/models/operations/createpresetsmessagesrequest.mdx @@ -6,5 +6,5 @@ title: "CreatePresetsMessagesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `MessagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | \ No newline at end of file +| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `MessagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest.mdx) | ✅ | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetsresponsesrequest.mdx b/docs/models/operations/createpresetsresponsesrequest.mdx index 6bb668f9e..61dc0be3d 100644 --- a/docs/models/operations/createpresetsresponsesrequest.mdx +++ b/docs/models/operations/createpresetsresponsesrequest.mdx @@ -6,5 +6,5 @@ title: "CreatePresetsResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file +| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file diff --git a/docs/models/operations/createprivateendpointrequest.mdx b/docs/models/operations/createprivateendpointrequest.mdx index fa8fcbf24..5e5266d31 100644 --- a/docs/models/operations/createprivateendpointrequest.mdx +++ b/docs/models/operations/createprivateendpointrequest.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `IdempotencyKey` | `*string` | :heavy_minus_sign: | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | -| `CreatePrivateEndpointRequest` | [components.CreatePrivateEndpointRequest](../../models/components/createprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `IdempotencyKey` | `*string` | ➖ | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | +| `CreatePrivateEndpointRequest` | [components.CreatePrivateEndpointRequest](../../models/components/createprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/creatererankrequest.mdx b/docs/models/operations/creatererankrequest.mdx index 2172a222f..760b4c654 100644 --- a/docs/models/operations/creatererankrequest.mdx +++ b/docs/models/operations/creatererankrequest.mdx @@ -9,11 +9,11 @@ Rerank request input | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Documents` | [][operations.Document](../../models/operations/document.mdx) | :heavy_check_mark: | The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | -| `Model` | `string` | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `Query` | `string` | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | -| `SessionID` | `*string` | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `TopN` | `*int64` | :heavy_minus_sign: | Number of most relevant documents to return | 3 | -| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `User` | `*string` | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `Documents` | [][operations.Document](../../models/operations/document.mdx) | ✅ | The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | +| `Model` | `string` | ✅ | The rerank model to use | cohere/rerank-v3.5 | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `Query` | `string` | ✅ | The search query to rerank documents against | What is the capital of France? | +| `SessionID` | `*string` | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `TopN` | `*int64` | ➖ | Number of most relevant documents to return | 3 | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `User` | `*string` | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/operations/creatererankresponsebody.mdx b/docs/models/operations/creatererankresponsebody.mdx index d9d8a5dbd..812f9579d 100644 --- a/docs/models/operations/creatererankresponsebody.mdx +++ b/docs/models/operations/creatererankresponsebody.mdx @@ -9,8 +9,8 @@ Rerank response containing ranked results | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ID` | `*string` | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | -| `Model` | `string` | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | -| `Provider` | `*string` | :heavy_minus_sign: | The provider that served the rerank request | Cohere | -| `Results` | [][operations.Result](../../models/operations/result.mdx) | :heavy_check_mark: | List of rerank results sorted by relevance | [
\{
"document": \{
"text": "Paris is the capital of France."
},
"index": 0,
"relevance_score": 0.98
}
] | -| `Usage` | [*operations.CreateRerankUsage](../../models/operations/creatererankusage.mdx) | :heavy_minus_sign: | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file +| `ID` | `*string` | ➖ | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | +| `Model` | `string` | ✅ | The model used for reranking | cohere/rerank-v3.5 | +| `Provider` | `*string` | ➖ | The provider that served the rerank request | Cohere | +| `Results` | [][operations.Result](../../models/operations/result.mdx) | ✅ | List of rerank results sorted by relevance | [
\{
"document": \{
"text": "Paris is the capital of France."
},
"index": 0,
"relevance_score": 0.98
}
] | +| `Usage` | [*operations.CreateRerankUsage](../../models/operations/creatererankusage.mdx) | ➖ | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file diff --git a/docs/models/operations/creatererankusage.mdx b/docs/models/operations/creatererankusage.mdx index f9934ff28..2f8127ec7 100644 --- a/docs/models/operations/creatererankusage.mdx +++ b/docs/models/operations/creatererankusage.mdx @@ -9,6 +9,6 @@ Usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.001 | -| `SearchUnits` | `*int64` | :heavy_minus_sign: | Number of search units consumed (Cohere billing) | 1 | -| `TotalTokens` | `*int64` | :heavy_minus_sign: | Total number of tokens used | 150 | \ No newline at end of file +| `Cost` | `*float64` | ➖ | Cost of the request in credits | 0.001 | +| `SearchUnits` | `*int64` | ➖ | Number of search units consumed (Cohere billing) | 1 | +| `TotalTokens` | `*int64` | ➖ | Total number of tokens used | 150 | \ No newline at end of file diff --git a/docs/models/operations/createresponsesrequest.mdx b/docs/models/operations/createresponsesrequest.mdx index 3af4a4167..9d7795b93 100644 --- a/docs/models/operations/createresponsesrequest.mdx +++ b/docs/models/operations/createresponsesrequest.mdx @@ -6,5 +6,5 @@ title: "CreateResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file +| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file diff --git a/docs/models/operations/createscimsyncjobresponse.mdx b/docs/models/operations/createscimsyncjobresponse.mdx index 3105b213b..9fd78a6a7 100644 --- a/docs/models/operations/createscimsyncjobresponse.mdx +++ b/docs/models/operations/createscimsyncjobresponse.mdx @@ -6,5 +6,5 @@ title: "CreateScimSyncJobResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | -| `Result` | [components.CreateScimSyncJobResponse](../../models/components/createscimsyncjobresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Headers` | map[string][]`string` | ✅ | N/A | +| `Result` | [components.CreateScimSyncJobResponse](../../models/components/createscimsyncjobresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/deletebatchrequest.mdx b/docs/models/operations/deletebatchrequest.mdx index eec48db98..70d2b1a75 100644 --- a/docs/models/operations/deletebatchrequest.mdx +++ b/docs/models/operations/deletebatchrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteBatchRequest" | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `ID` | `string` | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/models/operations/deletebyokkeyrequest.mdx b/docs/models/operations/deletebyokkeyrequest.mdx index d5e78b429..c898aa437 100644 --- a/docs/models/operations/deletebyokkeyrequest.mdx +++ b/docs/models/operations/deletebyokkeyrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `ID` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/models/operations/deleteenduserrequest.mdx b/docs/models/operations/deleteenduserrequest.mdx index 94e9f4d32..9fcd0d5ae 100644 --- a/docs/models/operations/deleteenduserrequest.mdx +++ b/docs/models/operations/deleteenduserrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file +| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file diff --git a/docs/models/operations/deletefilerequest.mdx b/docs/models/operations/deletefilerequest.mdx index 1167b1c09..694972222 100644 --- a/docs/models/operations/deletefilerequest.mdx +++ b/docs/models/operations/deletefilerequest.mdx @@ -6,6 +6,6 @@ title: "DeleteFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `FileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/deleteguardrailrequest.mdx b/docs/models/operations/deleteguardrailrequest.mdx index a89dfc012..8eb08ea42 100644 --- a/docs/models/operations/deleteguardrailrequest.mdx +++ b/docs/models/operations/deleteguardrailrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/deleteinternrequest.mdx b/docs/models/operations/deleteinternrequest.mdx index 1afa9fe2e..969a92eb3 100644 --- a/docs/models/operations/deleteinternrequest.mdx +++ b/docs/models/operations/deleteinternrequest.mdx @@ -6,5 +6,5 @@ title: "DeleteInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `DeleteInternRequest` | [components.DeleteInternRequest](../../models/components/deleteinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `DeleteInternRequest` | [components.DeleteInternRequest](../../models/components/deleteinternrequest.mdx) | ✅ | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file diff --git a/docs/models/operations/deleteinternvaultsecretrequest.mdx b/docs/models/operations/deleteinternvaultsecretrequest.mdx index 276ef5144..5246355f4 100644 --- a/docs/models/operations/deleteinternvaultsecretrequest.mdx +++ b/docs/models/operations/deleteinternvaultsecretrequest.mdx @@ -6,5 +6,5 @@ title: "DeleteInternVaultSecretRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `Name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file +| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `Name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file diff --git a/docs/models/operations/deletekeysrequest.mdx b/docs/models/operations/deletekeysrequest.mdx index ed98c7c54..34409f513 100644 --- a/docs/models/operations/deletekeysrequest.mdx +++ b/docs/models/operations/deletekeysrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteKeysRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `Hash` | `string` | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/models/operations/deletekeysresponse.mdx b/docs/models/operations/deletekeysresponse.mdx index 47d73b329..8b98c2ee4 100644 --- a/docs/models/operations/deletekeysresponse.mdx +++ b/docs/models/operations/deletekeysresponse.mdx @@ -9,4 +9,4 @@ API key deleted successfully | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file +| `Deleted` | `bool` | ✅ | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/docs/models/operations/deleteobservabilitydestinationrequest.mdx b/docs/models/operations/deleteobservabilitydestinationrequest.mdx index e9b969080..261205288 100644 --- a/docs/models/operations/deleteobservabilitydestinationrequest.mdx +++ b/docs/models/operations/deleteobservabilitydestinationrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `ID` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/models/operations/deleteprivateendpointrequest.mdx b/docs/models/operations/deleteprivateendpointrequest.mdx index dec053747..17f8cd3bd 100644 --- a/docs/models/operations/deleteprivateendpointrequest.mdx +++ b/docs/models/operations/deleteprivateendpointrequest.mdx @@ -6,5 +6,5 @@ title: "DeletePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `DraftOnly` | [*operations.DraftOnly](../../models/operations/draftonly.mdx) | :heavy_minus_sign: | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `DraftOnly` | [*operations.DraftOnly](../../models/operations/draftonly.mdx) | ➖ | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | \ No newline at end of file diff --git a/docs/models/operations/deletescimgroupmappingrequest.mdx b/docs/models/operations/deletescimgroupmappingrequest.mdx index 13e0fc78a..a45b693af 100644 --- a/docs/models/operations/deletescimgroupmappingrequest.mdx +++ b/docs/models/operations/deletescimgroupmappingrequest.mdx @@ -6,5 +6,5 @@ title: "DeleteScimGroupMappingRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `KeepMembers` | [operations.KeepMembers](../../models/operations/keepmembers.mdx) | :heavy_check_mark: | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | | +| `KeepMembers` | [operations.KeepMembers](../../models/operations/keepmembers.mdx) | ✅ | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | \ No newline at end of file diff --git a/docs/models/operations/deletevaultsecretrequest.mdx b/docs/models/operations/deletevaultsecretrequest.mdx index 26eae4534..3f778906a 100644 --- a/docs/models/operations/deletevaultsecretrequest.mdx +++ b/docs/models/operations/deletevaultsecretrequest.mdx @@ -6,4 +6,4 @@ title: "DeleteVaultSecretRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file +| `Name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacebudgetrequest.mdx b/docs/models/operations/deleteworkspacebudgetrequest.mdx index 50c31c754..37bc8bb00 100644 --- a/docs/models/operations/deleteworkspacebudgetrequest.mdx +++ b/docs/models/operations/deleteworkspacebudgetrequest.mdx @@ -6,5 +6,5 @@ title: "DeleteWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `WorkspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file +| `WorkspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacerequest.mdx b/docs/models/operations/deleteworkspacerequest.mdx index 76bee53e8..2f9df026c 100644 --- a/docs/models/operations/deleteworkspacerequest.mdx +++ b/docs/models/operations/deleteworkspacerequest.mdx @@ -6,5 +6,5 @@ title: "DeleteWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `ConfirmDefaultWorkspaceDeletion` | `*bool` | :heavy_minus_sign: | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | \ No newline at end of file +| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `ConfirmDefaultWorkspaceDeletion` | `*bool` | ➖ | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | \ No newline at end of file diff --git a/docs/models/operations/dimension.mdx b/docs/models/operations/dimension.mdx index 2f6ade1b0..f38e616ee 100644 --- a/docs/models/operations/dimension.mdx +++ b/docs/models/operations/dimension.mdx @@ -6,5 +6,5 @@ title: "Dimension" | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `DisplayLabel` | `string` | :heavy_check_mark: | Human-readable label | Model | -| `Name` | `string` | :heavy_check_mark: | Dimension identifier used in query requests | model | \ No newline at end of file +| `DisplayLabel` | `string` | ✅ | Human-readable label | Model | +| `Name` | `string` | ✅ | Dimension identifier used in query requests | model | \ No newline at end of file diff --git a/docs/models/operations/disableprivateendpointrequest.mdx b/docs/models/operations/disableprivateendpointrequest.mdx index 50d492737..e87d68061 100644 --- a/docs/models/operations/disableprivateendpointrequest.mdx +++ b/docs/models/operations/disableprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "DisablePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/documentrequest.mdx b/docs/models/operations/documentrequest.mdx index dde687d58..2fe807485 100644 --- a/docs/models/operations/documentrequest.mdx +++ b/docs/models/operations/documentrequest.mdx @@ -9,5 +9,5 @@ A structured document with optional text and/or image content. At least one of ` | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Image` | `*string` | :heavy_minus_sign: | An image associated with the document, as a remote URL (http/https) or a base64-encoded data URI (data:image/...). | https://upload.wikimedia.org/wikipedia/commons/thumb/8/8b/Phytogenic.png | -| `Text` | `*string` | :heavy_minus_sign: | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file +| `Image` | `*string` | ➖ | An image associated with the document, as a remote URL (http/https) or a base64-encoded data URI (data:image/...). | https://upload.wikimedia.org/wikipedia/commons/thumb/8/8b/Phytogenic.png | +| `Text` | `*string` | ➖ | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file diff --git a/docs/models/operations/documentresponse.mdx b/docs/models/operations/documentresponse.mdx index 8fa1f1795..f0f9dd4e0 100644 --- a/docs/models/operations/documentresponse.mdx +++ b/docs/models/operations/documentresponse.mdx @@ -9,5 +9,5 @@ The document object echoing the original input (text and/or image) | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `Image` | `*string` | :heavy_minus_sign: | The image (URL or data URI) from the original document | https://example.com/image.png | -| `Text` | `*string` | :heavy_minus_sign: | The document text | Paris is the capital of France. | \ No newline at end of file +| `Image` | `*string` | ➖ | The image (URL or data URI) from the original document | https://example.com/image.png | +| `Text` | `*string` | ➖ | The document text | Paris is the capital of France. | \ No newline at end of file diff --git a/docs/models/operations/downloadcontainerfilecontentrequest.mdx b/docs/models/operations/downloadcontainerfilecontentrequest.mdx index 67d867374..e56d30e0c 100644 --- a/docs/models/operations/downloadcontainerfilecontentrequest.mdx +++ b/docs/models/operations/downloadcontainerfilecontentrequest.mdx @@ -6,5 +6,5 @@ title: "DownloadContainerFileContentRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `FileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `ContainerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `FileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/downloadfilecontentrequest.mdx b/docs/models/operations/downloadfilecontentrequest.mdx index 6f311f374..ddd67d891 100644 --- a/docs/models/operations/downloadfilecontentrequest.mdx +++ b/docs/models/operations/downloadfilecontentrequest.mdx @@ -6,6 +6,6 @@ title: "DownloadFileContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `FileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/enableprivateendpointrequest.mdx b/docs/models/operations/enableprivateendpointrequest.mdx index 6abebf4fd..8f29c4906 100644 --- a/docs/models/operations/enableprivateendpointrequest.mdx +++ b/docs/models/operations/enableprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "EnablePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx index 728bab699..023ef1c82 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx @@ -6,6 +6,6 @@ title: "ExchangeAuthCodeForAPIKeyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Code` | `string` | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `CodeChallengeMethod` | optionalnullable.OptionalNullable[[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod.mdx)] | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `CodeVerifier` | `*string` | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | \ No newline at end of file +| `Code` | `string` | ✅ | The authorization code received from the OAuth redirect | auth_code_abc123def456 | +| `CodeChallengeMethod` | optionalnullable.OptionalNullable[[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod.mdx)] | ➖ | The method used to generate the code challenge | S256 | +| `CodeVerifier` | `*string` | ➖ | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx b/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx index 09ca68538..4dc064e10 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx @@ -9,5 +9,5 @@ Successfully exchanged code for an API key | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Key` | `string` | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | -| `UserID` | `*string` | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file +| `Key` | `string` | ✅ | The API key to use for OpenRouter requests | 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 | +| `UserID` | `*string` | ✅ | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/docs/models/operations/external.mdx b/docs/models/operations/external.mdx index 8ac7dfaa3..253501b1e 100644 --- a/docs/models/operations/external.mdx +++ b/docs/models/operations/external.mdx @@ -9,5 +9,5 @@ Optional partner-defined identity associated with the created API key. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `APIKey` | `*string` | :heavy_minus_sign: | Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned. | | -| `User` | `string` | :heavy_check_mark: | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file +| `APIKey` | `*string` | ➖ | Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned. | | +| `User` | `string` | ✅ | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file diff --git a/docs/models/operations/filter.mdx b/docs/models/operations/filter.mdx index 928761d40..33f54c268 100644 --- a/docs/models/operations/filter.mdx +++ b/docs/models/operations/filter.mdx @@ -6,7 +6,7 @@ title: "Filter" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Field` | `string` | :heavy_check_mark: | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | -| `IncludeUnset` | `*bool` | :heavy_minus_sign: | Include rows where the dimension has no value. Applies only to the `in` and `not_in` operators and dimensions that have an unset bucket. | | -| `Operator` | `string` | :heavy_check_mark: | Filter operator | eq | -| `Value` | [operations.Value1](../../models/operations/value1.mdx) | :heavy_check_mark: | Filter value (scalar or array depending on operator). Several dimensions are enriched in responses (returned as human-readable labels), but filters must use the underlying ID: `api_key_id` — numeric ID (from generation metadata) or key hash (64-char hex from GET /api/v1/keys, resolved server-side); `user` — Clerk user ID (e.g. "user_abc123"), not the display name; `workspace` — workspace UUID, not the workspace name (filtering or grouping by the account default workspace also covers activity recorded before workspace resolution existed, which is attributed to that default workspace); `app` — numeric app ID, not the app title; `model` — permaslug (e.g. "openai/gpt-4o"), not the display name. Other dimensions (provider, origin, country, etc.) are not enriched and accept the value as returned. | | \ No newline at end of file +| `Field` | `string` | ✅ | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | +| `IncludeUnset` | `*bool` | ➖ | Include rows where the dimension has no value. Applies only to the `in` and `not_in` operators and dimensions that have an unset bucket. | | +| `Operator` | `string` | ✅ | Filter operator | eq | +| `Value` | [operations.Value1](../../models/operations/value1.mdx) | ✅ | Filter value (scalar or array depending on operator). Several dimensions are enriched in responses (returned as human-readable labels), but filters must use the underlying ID: `api_key_id` — numeric ID (from generation metadata) or key hash (64-char hex from GET /api/v1/keys, resolved server-side); `user` — Clerk user ID (e.g. "user_abc123"), not the display name; `workspace` — workspace UUID, not the workspace name (filtering or grouping by the account default workspace also covers activity recorded before workspace resolution existed, which is attributed to that default workspace); `app` — numeric app ID, not the app title; `model` — permaslug (e.g. "openai/gpt-4o"), not the display name. Other dimensions (provider, origin, country, etc.) are not enriched and accept the value as returned. | | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetadata.mdx b/docs/models/operations/getanalyticsmetadata.mdx index d984d60ef..4e444c9e6 100644 --- a/docs/models/operations/getanalyticsmetadata.mdx +++ b/docs/models/operations/getanalyticsmetadata.mdx @@ -6,7 +6,7 @@ title: "GetAnalyticsMetaData" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Dimensions` | [][operations.Dimension](../../models/operations/dimension.mdx) | :heavy_check_mark: | N/A | -| `Granularities` | [][operations.Granularity](../../models/operations/granularity.mdx) | :heavy_check_mark: | N/A | -| `Metrics` | [][operations.Metric](../../models/operations/metric.mdx) | :heavy_check_mark: | N/A | -| `Operators` | [][operations.Operator](../../models/operations/operator.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Dimensions` | [][operations.Dimension](../../models/operations/dimension.mdx) | ✅ | N/A | +| `Granularities` | [][operations.Granularity](../../models/operations/granularity.mdx) | ✅ | N/A | +| `Metrics` | [][operations.Metric](../../models/operations/metric.mdx) | ✅ | N/A | +| `Operators` | [][operations.Operator](../../models/operations/operator.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetaresponse.mdx b/docs/models/operations/getanalyticsmetaresponse.mdx index 3c59f3543..a54dcc403 100644 --- a/docs/models/operations/getanalyticsmetaresponse.mdx +++ b/docs/models/operations/getanalyticsmetaresponse.mdx @@ -9,4 +9,4 @@ Returns analytics query metadata | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Data` | [operations.GetAnalyticsMetaData](../../models/operations/getanalyticsmetadata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [operations.GetAnalyticsMetaData](../../models/operations/getanalyticsmetadata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getapprankingsrequest.mdx b/docs/models/operations/getapprankingsrequest.mdx index 062c2050c..09f3ba851 100644 --- a/docs/models/operations/getapprankingsrequest.mdx +++ b/docs/models/operations/getapprankingsrequest.mdx @@ -6,10 +6,10 @@ title: "GetAppRankingsRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Category` | [*operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory.mdx) | :heavy_minus_sign: | Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group. | coding | -| `Subcategory` | [*operations.Subcategory](../../models/operations/subcategory.mdx) | :heavy_minus_sign: | Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent. | cli-agent | -| `Sort` | [*operations.GetAppRankingsSort](../../models/operations/getapprankingssort.mdx) | :heavy_minus_sign: | `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results. | popular | -| `StartDate` | `*string` | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | -| `EndDate` | `*string` | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`. | 0 | \ No newline at end of file +| `Category` | [*operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory.mdx) | ➖ | Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group. | coding | +| `Subcategory` | [*operations.Subcategory](../../models/operations/subcategory.mdx) | ➖ | Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent. | cli-agent | +| `Sort` | [*operations.GetAppRankingsSort](../../models/operations/getapprankingssort.mdx) | ➖ | `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results. | popular | +| `StartDate` | `*string` | ➖ | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | +| `EndDate` | `*string` | ➖ | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | +| `Limit` | `*int64` | ➖ | Maximum number of apps to return (1-100). Defaults to 50. | 50 | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`. | 0 | \ No newline at end of file diff --git a/docs/models/operations/getapprankingsresponse.mdx b/docs/models/operations/getapprankingsresponse.mdx index e1bd436e3..bf0c5da30 100644 --- a/docs/models/operations/getapprankingsresponse.mdx +++ b/docs/models/operations/getapprankingsresponse.mdx @@ -6,4 +6,4 @@ title: "GetAppRankingsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.AppRankingsResponse](../../models/components/apprankingsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"app_id": 12345,
"app_name": "Cline",
"rank": 1,
"total_requests": 4321,
"total_tokens": "12345678"
},
\{
"app_id": 67890,
"app_name": "Roo Code",
"rank": 2,
"total_requests": 2109,
"total_tokens": "9876543"
}
],
"meta": \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file +| `Result` | [components.AppRankingsResponse](../../models/components/apprankingsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"app_id": 12345,
"app_name": "Cline",
"rank": 1,
"total_requests": 4321,
"total_tokens": "12345678"
},
\{
"app_id": 67890,
"app_name": "Roo Code",
"rank": 2,
"total_requests": 2109,
"total_tokens": "9876543"
}
],
"meta": \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file diff --git a/docs/models/operations/getbatchesrequest.mdx b/docs/models/operations/getbatchesrequest.mdx index b3f3e9b10..92c68a92c 100644 --- a/docs/models/operations/getbatchesrequest.mdx +++ b/docs/models/operations/getbatchesrequest.mdx @@ -6,4 +6,4 @@ title: "GetBatchesRequest" | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `ID` | `string` | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/models/operations/getbenchmarksrequest.mdx b/docs/models/operations/getbenchmarksrequest.mdx index 256e326ac..b8ea3b585 100644 --- a/docs/models/operations/getbenchmarksrequest.mdx +++ b/docs/models/operations/getbenchmarksrequest.mdx @@ -6,12 +6,12 @@ title: "GetBenchmarksRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Source` | [*operations.Source](../../models/operations/source.mdx) | :heavy_minus_sign: | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | -| `TaskType` | [*operations.TaskType](../../models/operations/tasktype.mdx) | :heavy_minus_sign: | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. `search` returns OpenRouter search benchmark results only. | coding | -| `BenchmarkType` | [*operations.BenchmarkType](../../models/operations/benchmarktype.mdx) | :heavy_minus_sign: | Return results for one exact OpenRouter benchmark. A `search_*` value narrows the response to search results only; a classic value narrows the OpenRouter items and leaves other sources' items as they are. | search_widesearch | -| `IncludeRunConfig` | `*bool` | :heavy_minus_sign: | Search benchmarks only: include the published lane configuration whitelist in each search item. Defaults to false. The whitelist is limited to agent turn count, reasoning effort, and temperature so future harness configuration changes do not change the public contract. | true | -| `SearchEngine` | `*string` | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the search engine used. | exa | -| `SearchSurface` | [*operations.SearchSurface](../../models/operations/searchsurface.mdx) | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | -| `Arena` | [*operations.Arena](../../models/operations/arena.mdx) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | -| `Category` | `*string` | :heavy_minus_sign: | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file +| `Source` | [*operations.Source](../../models/operations/source.mdx) | ➖ | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | +| `TaskType` | [*operations.TaskType](../../models/operations/tasktype.mdx) | ➖ | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. `search` returns OpenRouter search benchmark results only. | coding | +| `BenchmarkType` | [*operations.BenchmarkType](../../models/operations/benchmarktype.mdx) | ➖ | Return results for one exact OpenRouter benchmark. A `search_*` value narrows the response to search results only; a classic value narrows the OpenRouter items and leaves other sources' items as they are. | search_widesearch | +| `IncludeRunConfig` | `*bool` | ➖ | Search benchmarks only: include the published lane configuration whitelist in each search item. Defaults to false. The whitelist is limited to agent turn count, reasoning effort, and temperature so future harness configuration changes do not change the public contract. | true | +| `SearchEngine` | `*string` | ➖ | OpenRouter search benchmarks only: filter by the search engine used. | exa | +| `SearchSurface` | [*operations.SearchSurface](../../models/operations/searchsurface.mdx) | ➖ | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | +| `Arena` | [*operations.Arena](../../models/operations/arena.mdx) | ➖ | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | +| `Category` | `*string` | ➖ | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | +| `MaxResults` | `*int64` | ➖ | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file diff --git a/docs/models/operations/getbyokkeyrequest.mdx b/docs/models/operations/getbyokkeyrequest.mdx index a89b223c2..8f82cd9d7 100644 --- a/docs/models/operations/getbyokkeyrequest.mdx +++ b/docs/models/operations/getbyokkeyrequest.mdx @@ -6,4 +6,4 @@ title: "GetBYOKKeyRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `ID` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/models/operations/getcontainerfilerequest.mdx b/docs/models/operations/getcontainerfilerequest.mdx index 4799b6493..402ea6e01 100644 --- a/docs/models/operations/getcontainerfilerequest.mdx +++ b/docs/models/operations/getcontainerfilerequest.mdx @@ -6,5 +6,5 @@ title: "GetContainerFileRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `FileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `ContainerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `FileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/getcreditsdata.mdx b/docs/models/operations/getcreditsdata.mdx index 25280a314..79c61fe3b 100644 --- a/docs/models/operations/getcreditsdata.mdx +++ b/docs/models/operations/getcreditsdata.mdx @@ -6,5 +6,5 @@ title: "GetCreditsData" | Field | Type | Required | Description | Example | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `TotalCredits` | `float64` | :heavy_check_mark: | Total credits purchased | 100.5 | -| `TotalUsage` | `float64` | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file +| `TotalCredits` | `float64` | ✅ | Total credits purchased | 100.5 | +| `TotalUsage` | `float64` | ✅ | Total credits used | 25.75 | \ No newline at end of file diff --git a/docs/models/operations/getcreditsresponse.mdx b/docs/models/operations/getcreditsresponse.mdx index 11dc4d56f..89a735654 100644 --- a/docs/models/operations/getcreditsresponse.mdx +++ b/docs/models/operations/getcreditsresponse.mdx @@ -9,4 +9,4 @@ Total credits purchased and used | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Data` | [operations.GetCreditsData](../../models/operations/getcreditsdata.mdx) | :heavy_check_mark: | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file +| `Data` | [operations.GetCreditsData](../../models/operations/getcreditsdata.mdx) | ✅ | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeydata.mdx b/docs/models/operations/getcurrentkeydata.mdx index 686566822..3a243cbe5 100644 --- a/docs/models/operations/getcurrentkeydata.mdx +++ b/docs/models/operations/getcurrentkeydata.mdx @@ -9,26 +9,26 @@ Current API key information | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDataRegions` | [][operations.AllowedDataRegion](../../models/operations/alloweddataregion.mdx) | :heavy_check_mark: | Data regions permitted for this API key by the guardrail policies on the key and the account regional-routing entitlement. Empty when no region is permitted. Reflects region policy only: other key restrictions, such as management keys being blocked from inference, still apply. | [
"global",
"europe",
"us"
] | -| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `FreeModelDailyRequests` | [components.FreeModelDailyRequests](../../models/components/freemodeldailyrequests.mdx) | :heavy_check_mark: | Free-model (`:free` variant) daily request quota for the account that owns the key. Reports the same counter and tier limit that free-model enforcement reads for accounts subject to the free-model limits; the counter resets at UTC midnight. Accounts and endpoints exempt from free-model limits, and BYOK requests, are not gated by it, so `remaining` is the tier policy rather than an enforced ceiling for them. | \{
"limit": 50,
"remaining": 38,
"used": 12
} | -| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `IsFreeTier` | `bool` | :heavy_check_mark: | Whether this is a free tier API key | false | -| `IsManagementKey` | `bool` | :heavy_check_mark: | Whether this is a management key | false | -| ~~`IsProvisioningKey`~~ | `bool` | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `OrganizationID` | `*string` | :heavy_check_mark: | The ID of the organization that owns this API key, or null when an individual account owns it. | null | -| ~~`RateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit.mdx) | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Legacy rate limit information about a key. Will always return -1. | \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
} | -| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `*string` | :heavy_check_mark: | The ID of the workspace this API key spends in, or null when no active workspace resolved for it, for example because the key's workspace was deleted. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `AllowedDataRegions` | [][operations.AllowedDataRegion](../../models/operations/alloweddataregion.mdx) | ✅ | Data regions permitted for this API key by the guardrail policies on the key and the account regional-routing entitlement. Empty when no region is permitted. Reflects region policy only: other key restrictions, such as management keys being blocked from inference, still apply. | [
"global",
"europe",
"us"
] | +| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `FreeModelDailyRequests` | [components.FreeModelDailyRequests](../../models/components/freemodeldailyrequests.mdx) | ✅ | Free-model (`:free` variant) daily request quota for the account that owns the key. Reports the same counter and tier limit that free-model enforcement reads for accounts subject to the free-model limits; the counter resets at UTC midnight. Accounts and endpoints exempt from free-model limits, and BYOK requests, are not gated by it, so `remaining` is the tier policy rather than an enforced ceiling for them. | \{
"limit": 50,
"remaining": 38,
"used": 12
} | +| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `IsFreeTier` | `bool` | ✅ | Whether this is a free tier API key | false | +| `IsManagementKey` | `bool` | ✅ | Whether this is a management key | false | +| ~~`IsProvisioningKey`~~ | `bool` | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | +| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | +| `OrganizationID` | `*string` | ✅ | The ID of the organization that owns this API key, or null when an individual account owns it. | null | +| ~~`RateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit.mdx) | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Legacy rate limit information about a key. Will always return -1. | \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
} | +| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `*string` | ✅ | The ID of the workspace this API key spends in, or null when no active workspace resolved for it, for example because the key's workspace was deleted. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeyresponse.mdx b/docs/models/operations/getcurrentkeyresponse.mdx index 0631c3dfe..83fd3451c 100644 --- a/docs/models/operations/getcurrentkeyresponse.mdx +++ b/docs/models/operations/getcurrentkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata.mdx) | :heavy_check_mark: | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"expires_at": "2027-12-31T23:59:59Z",
"free_model_daily_requests": \{
"limit": 50,
"remaining": 38,
"used": 12
},
"include_byok_in_limit": false,
"is_free_tier": false,
"is_management_key": false,
"is_provisioning_key": false,
"label": "sk-or-v1-au7...890",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"rate_limit": \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
},
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5
} | \ No newline at end of file +| `Data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata.mdx) | ✅ | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"expires_at": "2027-12-31T23:59:59Z",
"free_model_daily_requests": \{
"limit": 50,
"remaining": 38,
"used": 12
},
"include_byok_in_limit": false,
"is_free_tier": false,
"is_management_key": false,
"is_provisioning_key": false,
"label": "sk-or-v1-au7...890",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"rate_limit": \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
},
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5
} | \ No newline at end of file diff --git a/docs/models/operations/getenduserrequest.mdx b/docs/models/operations/getenduserrequest.mdx index 432f641e0..6940e1ffd 100644 --- a/docs/models/operations/getenduserrequest.mdx +++ b/docs/models/operations/getenduserrequest.mdx @@ -6,4 +6,4 @@ title: "GetEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file +| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | \ No newline at end of file diff --git a/docs/models/operations/getfilemetadatarequest.mdx b/docs/models/operations/getfilemetadatarequest.mdx index f75dd8493..d78f1a667 100644 --- a/docs/models/operations/getfilemetadatarequest.mdx +++ b/docs/models/operations/getfilemetadatarequest.mdx @@ -6,6 +6,6 @@ title: "GetFileMetadataRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `FileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `FileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/getgenerationrequest.mdx b/docs/models/operations/getgenerationrequest.mdx index fffa9af2d..eaed892c9 100644 --- a/docs/models/operations/getgenerationrequest.mdx +++ b/docs/models/operations/getgenerationrequest.mdx @@ -6,4 +6,4 @@ title: "GetGenerationRequest" | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file +| `ID` | `string` | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/models/operations/getguardrailrequest.mdx b/docs/models/operations/getguardrailrequest.mdx index f66e886eb..684137c8b 100644 --- a/docs/models/operations/getguardrailrequest.mdx +++ b/docs/models/operations/getguardrailrequest.mdx @@ -6,4 +6,4 @@ title: "GetGuardrailRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/getinterndaemonaccessrequest.mdx b/docs/models/operations/getinterndaemonaccessrequest.mdx index fcddf168a..a05847c1d 100644 --- a/docs/models/operations/getinterndaemonaccessrequest.mdx +++ b/docs/models/operations/getinterndaemonaccessrequest.mdx @@ -6,4 +6,4 @@ title: "GetInternDaemonAccessRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getinterndaemonrequest.mdx b/docs/models/operations/getinterndaemonrequest.mdx index 0194b7a0b..b0bed2a70 100644 --- a/docs/models/operations/getinterndaemonrequest.mdx +++ b/docs/models/operations/getinterndaemonrequest.mdx @@ -6,4 +6,4 @@ title: "GetInternDaemonRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getinternrequest.mdx b/docs/models/operations/getinternrequest.mdx index ccfda3818..9a9cc7e87 100644 --- a/docs/models/operations/getinternrequest.mdx +++ b/docs/models/operations/getinternrequest.mdx @@ -6,4 +6,4 @@ title: "GetInternRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getkeydata.mdx b/docs/models/operations/getkeydata.mdx index bf565b953..006a53a4b 100644 --- a/docs/models/operations/getkeydata.mdx +++ b/docs/models/operations/getkeydata.mdx @@ -9,26 +9,26 @@ The API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `ExternalUser` | `*string` | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `Disabled` | `bool` | ✅ | Whether the API key is disabled | false | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `ExternalUser` | `*string` | ✅ | Partner's end-user identifier used for attribution. | null | +| `Hash` | `string` | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | +| `Name` | `string` | ✅ | Name of the API key | My Production Key | +| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `string` | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/getkeyrequest.mdx b/docs/models/operations/getkeyrequest.mdx index 365e1df5d..0117d7c4c 100644 --- a/docs/models/operations/getkeyrequest.mdx +++ b/docs/models/operations/getkeyrequest.mdx @@ -6,4 +6,4 @@ title: "GetKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `Hash` | `string` | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/models/operations/getkeyresponse.mdx b/docs/models/operations/getkeyresponse.mdx index 127ba142f..31ef24b76 100644 --- a/docs/models/operations/getkeyresponse.mdx +++ b/docs/models/operations/getkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [operations.GetKeyData](../../models/operations/getkeydata.mdx) | :heavy_check_mark: | The API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [operations.GetKeyData](../../models/operations/getkeydata.mdx) | ✅ | The API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/operations/getmodelrequest.mdx b/docs/models/operations/getmodelrequest.mdx index 576eb6b1e..f9bba6641 100644 --- a/docs/models/operations/getmodelrequest.mdx +++ b/docs/models/operations/getmodelrequest.mdx @@ -6,5 +6,5 @@ title: "GetModelRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | -| `Slug` | `string` | :heavy_check_mark: | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | \ No newline at end of file +| `Author` | `string` | ✅ | The author/organization of the model | openai | +| `Slug` | `string` | ✅ | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | \ No newline at end of file diff --git a/docs/models/operations/getmodelsrequest.mdx b/docs/models/operations/getmodelsrequest.mdx index 14caaa839..ab38567d1 100644 --- a/docs/models/operations/getmodelsrequest.mdx +++ b/docs/models/operations/getmodelsrequest.mdx @@ -6,32 +6,32 @@ title: "GetModelsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `Category` | [*operations.GetModelsCategory](../../models/operations/getmodelscategory.mdx) | :heavy_minus_sign: | Filter models by use case category | programming | -| `SupportedParameters` | `*string` | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | -| `OutputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | -| `Sort` | [*operations.GetModelsSort](../../models/operations/getmodelssort.mdx) | :heavy_minus_sign: | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. | newest | -| `Q` | `*string` | :heavy_minus_sign: | Free-text search by model name or slug. | gpt-4 | -| `InputModalities` | `*string` | :heavy_minus_sign: | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | -| `Context` | `*int64` | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | -| `MinPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum prompt price in $/M tokens. | 0 | -| `MaxPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum prompt price in $/M tokens. | 10 | -| `Arch` | `*string` | :heavy_minus_sign: | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | -| `ModelAuthors` | `*string` | :heavy_minus_sign: | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | -| `Providers` | `*string` | :heavy_minus_sign: | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | -| `Distillable` | [*operations.Distillable](../../models/operations/distillable.mdx) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | -| `Zdr` | [*operations.Zdr](../../models/operations/zdr.mdx) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | -| `Region` | [*operations.Region](../../models/operations/region.mdx) | :heavy_minus_sign: | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | -| `MinOutputPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | -| `MaxOutputPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | -| `MinAgeDays` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | -| `MaxAgeDays` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum model age in days since its creation date. | 90 | -| `MinIntelligenceIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum Artificial Analysis intelligence index. | 50 | -| `MaxIntelligenceIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum Artificial Analysis intelligence index. | 100 | -| `MinCodingIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum Artificial Analysis coding index. | 50 | -| `MaxCodingIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum Artificial Analysis coding index. | 100 | -| `MinAgenticIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum Artificial Analysis agentic index. | 50 | -| `MaxAgenticIndex` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum Artificial Analysis agentic index. | 100 | -| `MinToolSuccessRate` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). | 0.9 | -| `MaxToolSuccessRate` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `Category` | [*operations.GetModelsCategory](../../models/operations/getmodelscategory.mdx) | ➖ | Filter models by use case category | programming | +| `SupportedParameters` | `*string` | ➖ | Filter models by supported parameter (comma-separated) | temperature | +| `OutputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | +| `Sort` | [*operations.GetModelsSort](../../models/operations/getmodelssort.mdx) | ➖ | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. | newest | +| `Q` | `*string` | ➖ | Free-text search by model name or slug. | gpt-4 | +| `InputModalities` | `*string` | ➖ | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | +| `Context` | `*int64` | ➖ | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | +| `MinPrice` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum prompt price in $/M tokens. | 0 | +| `MaxPrice` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum prompt price in $/M tokens. | 10 | +| `Arch` | `*string` | ➖ | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | +| `ModelAuthors` | `*string` | ➖ | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | +| `Providers` | `*string` | ➖ | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | +| `Distillable` | [*operations.Distillable](../../models/operations/distillable.mdx) | ➖ | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `Zdr` | [*operations.Zdr](../../models/operations/zdr.mdx) | ➖ | When set to "true", return only models with zero data retention endpoints. | true | +| `Region` | [*operations.Region](../../models/operations/region.mdx) | ➖ | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | +| `MinOutputPrice` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum completion (output) price in $/M tokens. | 0 | +| `MaxOutputPrice` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum completion (output) price in $/M tokens. | 10 | +| `MinAgeDays` | optionalnullable.OptionalNullable[`int64`] | ➖ | Minimum model age in days since its creation date. | 0 | +| `MaxAgeDays` | optionalnullable.OptionalNullable[`int64`] | ➖ | Maximum model age in days since its creation date. | 90 | +| `MinIntelligenceIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum Artificial Analysis intelligence index. | 50 | +| `MaxIntelligenceIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum Artificial Analysis intelligence index. | 100 | +| `MinCodingIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum Artificial Analysis coding index. | 50 | +| `MaxCodingIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum Artificial Analysis coding index. | 100 | +| `MinAgenticIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum Artificial Analysis agentic index. | 50 | +| `MaxAgenticIndex` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum Artificial Analysis agentic index. | 100 | +| `MinToolSuccessRate` | optionalnullable.OptionalNullable[`float64`] | ➖ | Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). | 0.9 | +| `MaxToolSuccessRate` | optionalnullable.OptionalNullable[`float64`] | ➖ | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file diff --git a/docs/models/operations/getmodelsresponse.mdx b/docs/models/operations/getmodelsresponse.mdx index dc7254dd0..8c224f892 100644 --- a/docs/models/operations/getmodelsresponse.mdx +++ b/docs/models/operations/getmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "GetModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/getobservabilitydestinationrequest.mdx b/docs/models/operations/getobservabilitydestinationrequest.mdx index 1b7ebf195..266e0c718 100644 --- a/docs/models/operations/getobservabilitydestinationrequest.mdx +++ b/docs/models/operations/getobservabilitydestinationrequest.mdx @@ -6,4 +6,4 @@ title: "GetObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `ID` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/models/operations/getorganizationsettingsresponse.mdx b/docs/models/operations/getorganizationsettingsresponse.mdx index e432f771c..033b2a96f 100644 --- a/docs/models/operations/getorganizationsettingsresponse.mdx +++ b/docs/models/operations/getorganizationsettingsresponse.mdx @@ -9,4 +9,4 @@ Organization settings | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.OrganizationSettings](../../models/components/organizationsettings.mdx) | :heavy_check_mark: | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file +| `Data` | [components.OrganizationSettings](../../models/components/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file diff --git a/docs/models/operations/getpresetrequest.mdx b/docs/models/operations/getpresetrequest.mdx index c24f183c9..d214c7a32 100644 --- a/docs/models/operations/getpresetrequest.mdx +++ b/docs/models/operations/getpresetrequest.mdx @@ -6,4 +6,4 @@ title: "GetPresetRequest" | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file +| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file diff --git a/docs/models/operations/getpresetversionrequest.mdx b/docs/models/operations/getpresetversionrequest.mdx index 519f31f1d..3733c88a0 100644 --- a/docs/models/operations/getpresetversionrequest.mdx +++ b/docs/models/operations/getpresetversionrequest.mdx @@ -6,5 +6,5 @@ title: "GetPresetVersionRequest" | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `Version` | `string` | :heavy_check_mark: | Version number of the preset. | 1 | \ No newline at end of file +| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | +| `Version` | `string` | ✅ | Version number of the preset. | 1 | \ No newline at end of file diff --git a/docs/models/operations/getprivateendpointrequest.mdx b/docs/models/operations/getprivateendpointrequest.mdx index bcc6ebac6..e7b82f35b 100644 --- a/docs/models/operations/getprivateendpointrequest.mdx +++ b/docs/models/operations/getprivateendpointrequest.mdx @@ -6,4 +6,4 @@ title: "GetPrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/getrankingsdailyrequest.mdx b/docs/models/operations/getrankingsdailyrequest.mdx index 45ad08830..b11f0134b 100644 --- a/docs/models/operations/getrankingsdailyrequest.mdx +++ b/docs/models/operations/getrankingsdailyrequest.mdx @@ -6,10 +6,10 @@ title: "GetRankingsDailyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `StartDate` | `*string` | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | -| `EndDate` | `*string` | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | -| `Period` | [*operations.Period](../../models/operations/period.mdx) | :heavy_minus_sign: | Time grain of each row. `day` (default) returns the per-UTC-day series; `week` buckets by ISO week start; `month` buckets by month start. With `category` or `language_type` only `week` (default) and `month` are available — `day` is rejected with a 400 because those datasets are aggregated weekly. For those sampled datasets `period=month` buckets each week by its week-start month, so totals are approximate at month boundaries. | day | -| `Modality` | [*operations.Modality](../../models/operations/modality.mdx) | :heavy_minus_sign: | Restrict to models for a modality surface: `text` / `image_output` match output modality, `image` / `audio` match input modality, and `tool_calling` keeps only rows that recorded at least one tool call. Exact dataset — cannot be combined with `category` or `language_type`. | text | -| `ContextBucket` | [*operations.ContextBucket](../../models/operations/contextbucket.mdx) | :heavy_minus_sign: | Restrict to requests whose context length falls in this bucket (`1K`, `10K`, `100K`, `1M`, or `10M`). Exact dataset — cannot be combined with `category` or `language_type`. | 100K | -| `Category` | [*operations.GetRankingsDailyCategory](../../models/operations/getrankingsdailycategory.mdx) | :heavy_minus_sign: | Restrict to a use-case category (e.g. `programming`, `roleplay`). Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `language_type`. | programming | -| `LanguageType` | [*operations.LanguageType](../../models/operations/languagetype.mdx) | :heavy_minus_sign: | Restrict to natural-language or programming-language tagged activity. Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `category`. | natural | \ No newline at end of file +| `StartDate` | `*string` | ➖ | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | +| `EndDate` | `*string` | ➖ | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | +| `Period` | [*operations.Period](../../models/operations/period.mdx) | ➖ | Time grain of each row. `day` (default) returns the per-UTC-day series; `week` buckets by ISO week start; `month` buckets by month start. With `category` or `language_type` only `week` (default) and `month` are available — `day` is rejected with a 400 because those datasets are aggregated weekly. For those sampled datasets `period=month` buckets each week by its week-start month, so totals are approximate at month boundaries. | day | +| `Modality` | [*operations.Modality](../../models/operations/modality.mdx) | ➖ | Restrict to models for a modality surface: `text` / `image_output` match output modality, `image` / `audio` match input modality, and `tool_calling` keeps only rows that recorded at least one tool call. Exact dataset — cannot be combined with `category` or `language_type`. | text | +| `ContextBucket` | [*operations.ContextBucket](../../models/operations/contextbucket.mdx) | ➖ | Restrict to requests whose context length falls in this bucket (`1K`, `10K`, `100K`, `1M`, or `10M`). Exact dataset — cannot be combined with `category` or `language_type`. | 100K | +| `Category` | [*operations.GetRankingsDailyCategory](../../models/operations/getrankingsdailycategory.mdx) | ➖ | Restrict to a use-case category (e.g. `programming`, `roleplay`). Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `language_type`. | programming | +| `LanguageType` | [*operations.LanguageType](../../models/operations/languagetype.mdx) | ➖ | Restrict to natural-language or programming-language tagged activity. Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `category`. | natural | \ No newline at end of file diff --git a/docs/models/operations/getscimgroupmappingrequest.mdx b/docs/models/operations/getscimgroupmappingrequest.mdx index 6efec4dd2..bc7b15c70 100644 --- a/docs/models/operations/getscimgroupmappingrequest.mdx +++ b/docs/models/operations/getscimgroupmappingrequest.mdx @@ -6,4 +6,4 @@ title: "GetScimGroupMappingRequest" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getscimsyncjobrequest.mdx b/docs/models/operations/getscimsyncjobrequest.mdx index 6a2de6f63..91b97e4a9 100644 --- a/docs/models/operations/getscimsyncjobrequest.mdx +++ b/docs/models/operations/getscimsyncjobrequest.mdx @@ -6,4 +6,4 @@ title: "GetScimSyncJobRequest" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getsessioncostrequest.mdx b/docs/models/operations/getsessioncostrequest.mdx index 1a3b5e044..7730c906b 100644 --- a/docs/models/operations/getsessioncostrequest.mdx +++ b/docs/models/operations/getsessioncostrequest.mdx @@ -6,8 +6,8 @@ title: "GetSessionCostRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `AppSlug` | `*string` | :heavy_minus_sign: | Filter to one published harness slug. | hermes-agent | -| `Model` | `*string` | :heavy_minus_sign: | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | -| `TurnRange` | [*operations.TurnRange](../../models/operations/turnrange.mdx) | :heavy_minus_sign: | Filter by the inclusive number of turns in a session. | 10-49-turns | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of cells to return (1-500). Defaults to 100. | 100 | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file +| `AppSlug` | `*string` | ➖ | Filter to one published harness slug. | hermes-agent | +| `Model` | `*string` | ➖ | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | +| `TurnRange` | [*operations.TurnRange](../../models/operations/turnrange.mdx) | ➖ | Filter by the inclusive number of turns in a session. | 10-49-turns | +| `Limit` | `*int64` | ➖ | Maximum number of cells to return (1-500). Defaults to 100. | 100 | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/getsessioncostresponse.mdx b/docs/models/operations/getsessioncostresponse.mdx index c319e4565..b95ccae59 100644 --- a/docs/models/operations/getsessioncostresponse.mdx +++ b/docs/models/operations/getsessioncostresponse.mdx @@ -6,4 +6,4 @@ title: "GetSessionCostResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Result` | [components.SessionCostResponse](../../models/components/sessioncostresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Result` | [components.SessionCostResponse](../../models/components/sessioncostresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/gettaskclassificationsrequest.mdx b/docs/models/operations/gettaskclassificationsrequest.mdx index a80174e69..ca08656c2 100644 --- a/docs/models/operations/gettaskclassificationsrequest.mdx +++ b/docs/models/operations/gettaskclassificationsrequest.mdx @@ -6,4 +6,4 @@ title: "GetTaskClassificationsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Window` | [*operations.Window](../../models/operations/window.mdx) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | \ No newline at end of file +| `Window` | [*operations.Window](../../models/operations/window.mdx) | ➖ | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | \ No newline at end of file diff --git a/docs/models/operations/gettoolrequest.mdx b/docs/models/operations/gettoolrequest.mdx index 3fafe4f61..9daab90a4 100644 --- a/docs/models/operations/gettoolrequest.mdx +++ b/docs/models/operations/gettoolrequest.mdx @@ -6,4 +6,4 @@ title: "GetToolRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Name` | `string` | :heavy_check_mark: | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file +| `Name` | `string` | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file diff --git a/docs/models/operations/gettoolresponse.mdx b/docs/models/operations/gettoolresponse.mdx index 1fa45c0b5..605a89853 100644 --- a/docs/models/operations/gettoolresponse.mdx +++ b/docs/models/operations/gettoolresponse.mdx @@ -6,5 +6,5 @@ title: "GetToolResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | -| `Result` | [*components.GetToolResponse](../../models/components/gettoolresponse.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Headers` | map[string][]`string` | ✅ | N/A | +| `Result` | [*components.GetToolResponse](../../models/components/gettoolresponse.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/operations/gettoolsecurity.mdx b/docs/models/operations/gettoolsecurity.mdx index 95a591f90..56f9fe66a 100644 --- a/docs/models/operations/gettoolsecurity.mdx +++ b/docs/models/operations/gettoolsecurity.mdx @@ -6,4 +6,4 @@ title: "GetToolSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bearer` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bearer` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getuseractivityrequest.mdx b/docs/models/operations/getuseractivityrequest.mdx index 08fa27a64..144953a56 100644 --- a/docs/models/operations/getuseractivityrequest.mdx +++ b/docs/models/operations/getuseractivityrequest.mdx @@ -6,8 +6,8 @@ title: "GetUserActivityRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Date` | `*string` | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `APIKeyHash` | `*string` | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `UserID` | `*string` | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | -| `GroupBy` | [*operations.GroupBy](../../models/operations/groupby.mdx) | :heavy_minus_sign: | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `Date` | `*string` | ➖ | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | +| `APIKeyHash` | `*string` | ➖ | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | +| `UserID` | `*string` | ➖ | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | +| `GroupBy` | [*operations.GroupBy](../../models/operations/groupby.mdx) | ➖ | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | +| `WorkspaceID` | `*string` | ➖ | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/getvideosrequest.mdx b/docs/models/operations/getvideosrequest.mdx index 195169bbe..c7c6cb8e7 100644 --- a/docs/models/operations/getvideosrequest.mdx +++ b/docs/models/operations/getvideosrequest.mdx @@ -6,4 +6,4 @@ title: "GetVideosRequest" | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `JobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | \ No newline at end of file +| `JobID` | `string` | ✅ | N/A | job-abc123 | \ No newline at end of file diff --git a/docs/models/operations/getworkspacebudgetrequest.mdx b/docs/models/operations/getworkspacebudgetrequest.mdx index f9c1bade8..3d6766acc 100644 --- a/docs/models/operations/getworkspacebudgetrequest.mdx +++ b/docs/models/operations/getworkspacebudgetrequest.mdx @@ -6,5 +6,5 @@ title: "GetWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `WorkspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file +| `WorkspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file diff --git a/docs/models/operations/getworkspacerequest.mdx b/docs/models/operations/getworkspacerequest.mdx index f55c4a768..6deaba1d4 100644 --- a/docs/models/operations/getworkspacerequest.mdx +++ b/docs/models/operations/getworkspacerequest.mdx @@ -6,4 +6,4 @@ title: "GetWorkspaceRequest" | Field | Type | Required | Description | Example | | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/models/operations/granularity.mdx b/docs/models/operations/granularity.mdx index e63f71fac..3f84c2969 100644 --- a/docs/models/operations/granularity.mdx +++ b/docs/models/operations/granularity.mdx @@ -6,5 +6,5 @@ title: "Granularity" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `DisplayLabel` | `string` | :heavy_check_mark: | Human-readable label | Day | -| `Name` | [operations.GranularityName](../../models/operations/granularityname.mdx) | :heavy_check_mark: | Granularity identifier | day | \ No newline at end of file +| `DisplayLabel` | `string` | ✅ | Human-readable label | Day | +| `Name` | [operations.GranularityName](../../models/operations/granularityname.mdx) | ✅ | Granularity identifier | day | \ No newline at end of file diff --git a/docs/models/operations/imageurl.mdx b/docs/models/operations/imageurl.mdx index 5503dd2ce..791103a25 100644 --- a/docs/models/operations/imageurl.mdx +++ b/docs/models/operations/imageurl.mdx @@ -6,4 +6,4 @@ title: "ImageURL" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `URL` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/input.mdx b/docs/models/operations/input.mdx index 560e8b396..46f907ef1 100644 --- a/docs/models/operations/input.mdx +++ b/docs/models/operations/input.mdx @@ -6,4 +6,4 @@ title: "Input" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Content` | [][operations.Content](../../models/operations/content.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [][operations.Content](../../models/operations/content.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/invokeinternrequest.mdx b/docs/models/operations/invokeinternrequest.mdx index 809d031dd..3d514eb07 100644 --- a/docs/models/operations/invokeinternrequest.mdx +++ b/docs/models/operations/invokeinternrequest.mdx @@ -6,5 +6,5 @@ title: "InvokeInternRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `InternID` | `string` | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `InternInvokeRequest` | [components.InternInvokeRequest](../../models/components/interninvokerequest.mdx) | :heavy_check_mark: | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | \ No newline at end of file +| `InternID` | `string` | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `InternInvokeRequest` | [components.InternInvokeRequest](../../models/components/interninvokerequest.mdx) | ✅ | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | \ No newline at end of file diff --git a/docs/models/operations/invokeinternresponse.mdx b/docs/models/operations/invokeinternresponse.mdx index 0d577fbd9..c740f088b 100644 --- a/docs/models/operations/invokeinternresponse.mdx +++ b/docs/models/operations/invokeinternresponse.mdx @@ -6,5 +6,5 @@ title: "InvokeInternResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | | -| `Result` | [components.InternInvokeAcceptedResponse](../../models/components/interninvokeacceptedresponse.mdx) | :heavy_check_mark: | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file +| `Headers` | map[string][]`string` | ✅ | N/A | | +| `Result` | [components.InternInvokeAcceptedResponse](../../models/components/interninvokeacceptedresponse.mdx) | ✅ | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file diff --git a/docs/models/operations/listbatchesrequest.mdx b/docs/models/operations/listbatchesrequest.mdx index c5ac6fd04..9e4e7f371 100644 --- a/docs/models/operations/listbatchesrequest.mdx +++ b/docs/models/operations/listbatchesrequest.mdx @@ -6,8 +6,8 @@ title: "ListBatchesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of batches to return, from 1 through 100. | 20 | -| `After` | `*string` | :heavy_minus_sign: | Batch id from the previous page's `last_id`. | batch_7a4b02 | -| `Status` | [][components.BatchListStatus](../../models/components/batchliststatus.mdx) | :heavy_minus_sign: | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | -| `CreatedAfter` | [*components.BatchListTimestamp](../../models/components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | -| `CreatedBefore` | [*components.BatchListTimestamp](../../models/components/batchlisttimestamp.mdx) | :heavy_minus_sign: | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | \ No newline at end of file +| `Limit` | `*int64` | ➖ | Maximum number of batches to return, from 1 through 100. | 20 | +| `After` | `*string` | ➖ | Batch id from the previous page's `last_id`. | batch_7a4b02 | +| `Status` | [][components.BatchListStatus](../../models/components/batchliststatus.mdx) | ➖ | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | +| `CreatedAfter` | [*components.BatchListTimestamp](../../models/components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | +| `CreatedBefore` | [*components.BatchListTimestamp](../../models/components/batchlisttimestamp.mdx) | ➖ | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | \ No newline at end of file diff --git a/docs/models/operations/listbatchesresponse.mdx b/docs/models/operations/listbatchesresponse.mdx index a8d828c07..2c89581f1 100644 --- a/docs/models/operations/listbatchesresponse.mdx +++ b/docs/models/operations/listbatchesresponse.mdx @@ -6,4 +6,4 @@ title: "ListBatchesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Result` | [components.BatchListResponse](../../models/components/batchlistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [],
"first_id": null,
"has_more": false,
"last_id": null,
"object": "list"
} | \ No newline at end of file +| `Result` | [components.BatchListResponse](../../models/components/batchlistresponse.mdx) | ✅ | N/A | \{
"data": [],
"first_id": null,
"has_more": false,
"last_id": null,
"object": "list"
} | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysrequest.mdx b/docs/models/operations/listbyokkeysrequest.mdx index 66b2ffa3e..f9fe882db 100644 --- a/docs/models/operations/listbyokkeysrequest.mdx +++ b/docs/models/operations/listbyokkeysrequest.mdx @@ -6,7 +6,7 @@ title: "ListBYOKKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | -| `Provider` | [*operations.Provider](../../models/operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `WorkspaceID` | `*string` | ➖ | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | +| `Provider` | [*operations.Provider](../../models/operations/provider.mdx) | ➖ | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysresponse.mdx b/docs/models/operations/listbyokkeysresponse.mdx index 8cdcc228f..e566fd1c9 100644 --- a/docs/models/operations/listbyokkeysresponse.mdx +++ b/docs/models/operations/listbyokkeysresponse.mdx @@ -6,4 +6,4 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.ListBYOKKeysResponse](../../models/components/listbyokkeysresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListBYOKKeysResponse](../../models/components/listbyokkeysresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listcontainerfilesrequest.mdx b/docs/models/operations/listcontainerfilesrequest.mdx index 3074faa6b..ecfa78cb0 100644 --- a/docs/models/operations/listcontainerfilesrequest.mdx +++ b/docs/models/operations/listcontainerfilesrequest.mdx @@ -6,6 +6,6 @@ title: "ListContainerFilesRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `After` | `*string` | :heavy_minus_sign: | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `ContainerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `Limit` | `*int64` | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `After` | `*string` | ➖ | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/listdata.mdx b/docs/models/operations/listdata.mdx index ba0704639..8d00f1f4b 100644 --- a/docs/models/operations/listdata.mdx +++ b/docs/models/operations/listdata.mdx @@ -6,26 +6,26 @@ title: "ListData" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `ExternalUser` | `*string` | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `Disabled` | `bool` | ✅ | Whether the API key is disabled | false | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `ExternalUser` | `*string` | ✅ | Partner's end-user identifier used for attribution. | null | +| `Hash` | `string` | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | +| `Name` | `string` | ✅ | Name of the API key | My Production Key | +| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `string` | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listembeddingsmodelsrequest.mdx b/docs/models/operations/listembeddingsmodelsrequest.mdx index 98242d430..a76440dfb 100644 --- a/docs/models/operations/listembeddingsmodelsrequest.mdx +++ b/docs/models/operations/listembeddingsmodelsrequest.mdx @@ -6,5 +6,5 @@ title: "ListEmbeddingsModelsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | \ No newline at end of file diff --git a/docs/models/operations/listembeddingsmodelsresponse.mdx b/docs/models/operations/listembeddingsmodelsresponse.mdx index 2512a3f51..c033d393f 100644 --- a/docs/models/operations/listembeddingsmodelsresponse.mdx +++ b/docs/models/operations/listembeddingsmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "ListEmbeddingsModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/listendpointsrequest.mdx b/docs/models/operations/listendpointsrequest.mdx index 5addbc78d..54fa8fdbd 100644 --- a/docs/models/operations/listendpointsrequest.mdx +++ b/docs/models/operations/listendpointsrequest.mdx @@ -6,5 +6,5 @@ title: "ListEndpointsRequest" | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `Author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | -| `Slug` | `string` | :heavy_check_mark: | The model slug | gpt-4 | \ No newline at end of file +| `Author` | `string` | ✅ | The author/organization of the model | openai | +| `Slug` | `string` | ✅ | The model slug | gpt-4 | \ No newline at end of file diff --git a/docs/models/operations/listendpointsresponse.mdx b/docs/models/operations/listendpointsresponse.mdx index 8f62ed5fb..c7fc9a806 100644 --- a/docs/models/operations/listendpointsresponse.mdx +++ b/docs/models/operations/listendpointsresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.ListEndpointsResponse](../../models/components/listendpointsresponse.mdx) | :heavy_check_mark: | List of available endpoints for a model | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"created": 1692901234,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"endpoints": [
\{
"context_length": 8192,
"latency_last_30m": \{
"p50": 0.25,
"p75": 0.35,
"p90": 0.48,
"p99": 0.85
},
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"model_id": "openai/gpt-4",
"model_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"provider_name": "OpenAI",
"quantization": "fp16",
"status": 0,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supports_implicit_caching": true,
"tag": "openai",
"throughput_last_30m": \{
"p50": 45.2,
"p75": 38.5,
"p90": 28.3,
"p99": 15.1
},
"uptime_last_1d": 99.8,
"uptime_last_30m": 99.5,
"uptime_last_5m": 100
}
],
"id": "openai/gpt-4",
"name": "GPT-4"
} | \ No newline at end of file +| `Data` | [components.ListEndpointsResponse](../../models/components/listendpointsresponse.mdx) | ✅ | List of available endpoints for a model | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"created": 1692901234,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"endpoints": [
\{
"context_length": 8192,
"latency_last_30m": \{
"p50": 0.25,
"p75": 0.35,
"p90": 0.48,
"p99": 0.85
},
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"model_id": "openai/gpt-4",
"model_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"provider_name": "OpenAI",
"quantization": "fp16",
"status": 0,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supports_implicit_caching": true,
"tag": "openai",
"throughput_last_30m": \{
"p50": 45.2,
"p75": 38.5,
"p90": 28.3,
"p99": 15.1
},
"uptime_last_1d": 99.8,
"uptime_last_30m": 99.5,
"uptime_last_5m": 100
}
],
"id": "openai/gpt-4",
"name": "GPT-4"
} | \ No newline at end of file diff --git a/docs/models/operations/listendpointszdrresponse.mdx b/docs/models/operations/listendpointszdrresponse.mdx index 3aed99b5d..101eb01be 100644 --- a/docs/models/operations/listendpointszdrresponse.mdx +++ b/docs/models/operations/listendpointszdrresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Data` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listendusersrequest.mdx b/docs/models/operations/listendusersrequest.mdx index 7ea3dac06..f4ff01448 100644 --- a/docs/models/operations/listendusersrequest.mdx +++ b/docs/models/operations/listendusersrequest.mdx @@ -6,7 +6,7 @@ title: "ListEndUsersRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `User` | `*string` | :heavy_minus_sign: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | -| `IncludeInactive` | `*bool` | :heavy_minus_sign: | Include deactivated registrations. | false | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `User` | `*string` | ➖ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `IncludeInactive` | `*bool` | ➖ | Include deactivated registrations. | false | \ No newline at end of file diff --git a/docs/models/operations/listendusersresponse.mdx b/docs/models/operations/listendusersresponse.mdx index 44323704d..a7e70f9e9 100644 --- a/docs/models/operations/listendusersresponse.mdx +++ b/docs/models/operations/listendusersresponse.mdx @@ -6,4 +6,4 @@ title: "ListEndUsersResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListEndUsersResponse](../../models/components/listendusersresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListEndUsersResponse](../../models/components/listendusersresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listfilesrequest.mdx b/docs/models/operations/listfilesrequest.mdx index b4ae6e399..d7b639027 100644 --- a/docs/models/operations/listfilesrequest.mdx +++ b/docs/models/operations/listfilesrequest.mdx @@ -6,11 +6,11 @@ title: "ListFilesRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of files to return (1–1000). | 100 | -| `Cursor` | `*string` | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `After` | `*string` | :heavy_minus_sign: | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `AfterID` | `*string` | :heavy_minus_sign: | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `BeforeID` | `*string` | :heavy_minus_sign: | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `Order` | [*operations.Order](../../models/operations/order.mdx) | :heavy_minus_sign: | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file +| `Limit` | `*int64` | ➖ | Maximum number of files to return (1–1000). | 100 | +| `Cursor` | `*string` | ➖ | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | +| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `After` | `*string` | ➖ | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `AfterID` | `*string` | ➖ | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `BeforeID` | `*string` | ➖ | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `Order` | [*operations.Order](../../models/operations/order.mdx) | ➖ | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file diff --git a/docs/models/operations/listfilesresponse.mdx b/docs/models/operations/listfilesresponse.mdx index eae01171a..46d09bb4d 100644 --- a/docs/models/operations/listfilesresponse.mdx +++ b/docs/models/operations/listfilesresponse.mdx @@ -6,4 +6,4 @@ title: "ListFilesResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.FileListResponse](../../models/components/filelistresponse.mdx) | :heavy_check_mark: | N/A | \{
"_shape": "openrouter",
"cursor": null,
"data": [],
"first_id": null,
"has_more": false,
"last_id": null
} | \ No newline at end of file +| `Result` | [components.FileListResponse](../../models/components/filelistresponse.mdx) | ✅ | N/A | \{
"_shape": "openrouter",
"cursor": null,
"data": [],
"first_id": null,
"has_more": false,
"last_id": null
} | \ No newline at end of file diff --git a/docs/models/operations/listgenerationcontentrequest.mdx b/docs/models/operations/listgenerationcontentrequest.mdx index 8ea15cc26..16c99e27d 100644 --- a/docs/models/operations/listgenerationcontentrequest.mdx +++ b/docs/models/operations/listgenerationcontentrequest.mdx @@ -6,4 +6,4 @@ title: "ListGenerationContentRequest" | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file +| `ID` | `string` | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailkeyassignmentsrequest.mdx b/docs/models/operations/listguardrailkeyassignmentsrequest.mdx index f6c4df2bf..54a9449db 100644 --- a/docs/models/operations/listguardrailkeyassignmentsrequest.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsrequest.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailKeyAssignmentsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx index b1a2c2e2c..9c45755a1 100644 --- a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listguardrailmemberassignmentsrequest.mdx b/docs/models/operations/listguardrailmemberassignmentsrequest.mdx index 3af73135c..d3b7037a1 100644 --- a/docs/models/operations/listguardrailmemberassignmentsrequest.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsrequest.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailMemberAssignmentsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx index ee830a1c2..1d584934d 100644 --- a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listguardrailsrequest.mdx b/docs/models/operations/listguardrailsrequest.mdx index 260892889..cfe6be5ac 100644 --- a/docs/models/operations/listguardrailsrequest.mdx +++ b/docs/models/operations/listguardrailsrequest.mdx @@ -6,6 +6,6 @@ title: "ListGuardrailsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `WorkspaceID` | `*string` | ➖ | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailsresponse.mdx b/docs/models/operations/listguardrailsresponse.mdx index 67526da8e..8b4bae811 100644 --- a/docs/models/operations/listguardrailsresponse.mdx +++ b/docs/models/operations/listguardrailsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListGuardrailsResponse](../../models/components/listguardrailsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListGuardrailsResponse](../../models/components/listguardrailsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listimagemodelendpointsrequest.mdx b/docs/models/operations/listimagemodelendpointsrequest.mdx index c83a428b0..2f596beb0 100644 --- a/docs/models/operations/listimagemodelendpointsrequest.mdx +++ b/docs/models/operations/listimagemodelendpointsrequest.mdx @@ -6,5 +6,5 @@ title: "ListImageModelEndpointsRequest" | Field | Type | Required | Description | Example | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `Author` | `string` | :heavy_check_mark: | Model author/organization | bytedance-seed | -| `Slug` | `string` | :heavy_check_mark: | Model slug | seedream-4.5 | \ No newline at end of file +| `Author` | `string` | ✅ | Model author/organization | bytedance-seed | +| `Slug` | `string` | ✅ | Model slug | seedream-4.5 | \ No newline at end of file diff --git a/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx b/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx index aa12d39dd..78df22a14 100644 --- a/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx +++ b/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx @@ -6,6 +6,6 @@ title: "ListInternEffectiveVaultSecretsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `Limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `Offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `Limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `Offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listinternsrequest.mdx b/docs/models/operations/listinternsrequest.mdx index ec14bfd77..cb28ac484 100644 --- a/docs/models/operations/listinternsrequest.mdx +++ b/docs/models/operations/listinternsrequest.mdx @@ -6,7 +6,7 @@ title: "ListInternsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | -| `Status` | [][operations.Status](../../models/operations/status.mdx) | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `StartingAfter` | `*string` | :heavy_minus_sign: | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | \ No newline at end of file +| `Limit` | `*int64` | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | +| `Status` | [][operations.Status](../../models/operations/status.mdx) | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `StartingAfter` | `*string` | ➖ | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | +| `WorkspaceID` | `*string` | ➖ | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | \ No newline at end of file diff --git a/docs/models/operations/listinternvaultsecretsrequest.mdx b/docs/models/operations/listinternvaultsecretsrequest.mdx index 370d6f143..435fe5edb 100644 --- a/docs/models/operations/listinternvaultsecretsrequest.mdx +++ b/docs/models/operations/listinternvaultsecretsrequest.mdx @@ -6,6 +6,6 @@ title: "ListInternVaultSecretsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `Limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `Offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `Limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `Offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listkeyassignmentsrequest.mdx b/docs/models/operations/listkeyassignmentsrequest.mdx index 325a6b5de..6b7e92afb 100644 --- a/docs/models/operations/listkeyassignmentsrequest.mdx +++ b/docs/models/operations/listkeyassignmentsrequest.mdx @@ -6,5 +6,5 @@ title: "ListKeyAssignmentsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listkeyassignmentsresponse.mdx b/docs/models/operations/listkeyassignmentsresponse.mdx index 02bce345f..3b73c0222 100644 --- a/docs/models/operations/listkeyassignmentsresponse.mdx +++ b/docs/models/operations/listkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listmemberassignmentsrequest.mdx b/docs/models/operations/listmemberassignmentsrequest.mdx index ac8f63c94..b05cc99a5 100644 --- a/docs/models/operations/listmemberassignmentsrequest.mdx +++ b/docs/models/operations/listmemberassignmentsrequest.mdx @@ -6,5 +6,5 @@ title: "ListMemberAssignmentsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listmemberassignmentsresponse.mdx b/docs/models/operations/listmemberassignmentsresponse.mdx index f1ab24007..da1412e0e 100644 --- a/docs/models/operations/listmemberassignmentsresponse.mdx +++ b/docs/models/operations/listmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listmodelscountrequest.mdx b/docs/models/operations/listmodelscountrequest.mdx index 9cc8b943a..dfd5dd9f0 100644 --- a/docs/models/operations/listmodelscountrequest.mdx +++ b/docs/models/operations/listmodelscountrequest.mdx @@ -6,4 +6,4 @@ title: "ListModelsCountRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `OutputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file +| `OutputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file diff --git a/docs/models/operations/listmodelsuserrequest.mdx b/docs/models/operations/listmodelsuserrequest.mdx index b992b6990..e25cc0ef6 100644 --- a/docs/models/operations/listmodelsuserrequest.mdx +++ b/docs/models/operations/listmodelsuserrequest.mdx @@ -6,6 +6,6 @@ title: "ListModelsUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `OutputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `OutputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file diff --git a/docs/models/operations/listmodelsuserresponse.mdx b/docs/models/operations/listmodelsuserresponse.mdx index 2efd1749a..1a83c42b7 100644 --- a/docs/models/operations/listmodelsuserresponse.mdx +++ b/docs/models/operations/listmodelsuserresponse.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `Result` | [components.ModelsListResponse](../../models/components/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/listmodelsusersecurity.mdx b/docs/models/operations/listmodelsusersecurity.mdx index 3f2892bf6..dd5872669 100644 --- a/docs/models/operations/listmodelsusersecurity.mdx +++ b/docs/models/operations/listmodelsusersecurity.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bearer` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bearer` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listobservabilitydestinationsrequest.mdx b/docs/models/operations/listobservabilitydestinationsrequest.mdx index 9fef8bdc7..194c98c2d 100644 --- a/docs/models/operations/listobservabilitydestinationsrequest.mdx +++ b/docs/models/operations/listobservabilitydestinationsrequest.mdx @@ -6,6 +6,6 @@ title: "ListObservabilityDestinationsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `WorkspaceID` | `*string` | ➖ | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/listobservabilitydestinationsresponse.mdx b/docs/models/operations/listobservabilitydestinationsresponse.mdx index 48fcf78c5..7c987d73d 100644 --- a/docs/models/operations/listobservabilitydestinationsresponse.mdx +++ b/docs/models/operations/listobservabilitydestinationsresponse.mdx @@ -6,4 +6,4 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListObservabilityDestinationsResponse](../../models/components/listobservabilitydestinationsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListObservabilityDestinationsResponse](../../models/components/listobservabilitydestinationsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersdata.mdx b/docs/models/operations/listorganizationmembersdata.mdx index 9f22477b5..f58de7cd3 100644 --- a/docs/models/operations/listorganizationmembersdata.mdx +++ b/docs/models/operations/listorganizationmembersdata.mdx @@ -6,8 +6,8 @@ title: "ListOrganizationMembersData" | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Email` | `string` | :heavy_check_mark: | Email address of the member | jane.doe@example.com | -| `FirstName` | `*string` | :heavy_check_mark: | First name of the member | Jane | -| `ID` | `string` | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | -| `LastName` | `*string` | :heavy_check_mark: | Last name of the member | Doe | -| `Role` | [operations.Role](../../models/operations/role.mdx) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file +| `Email` | `string` | ✅ | Email address of the member | jane.doe@example.com | +| `FirstName` | `*string` | ✅ | First name of the member | Jane | +| `ID` | `string` | ✅ | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | +| `LastName` | `*string` | ✅ | Last name of the member | Doe | +| `Role` | [operations.Role](../../models/operations/role.mdx) | ✅ | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersrequest.mdx b/docs/models/operations/listorganizationmembersrequest.mdx index 672155084..664147d31 100644 --- a/docs/models/operations/listorganizationmembersrequest.mdx +++ b/docs/models/operations/listorganizationmembersrequest.mdx @@ -6,5 +6,5 @@ title: "ListOrganizationMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponse.mdx b/docs/models/operations/listorganizationmembersresponse.mdx index 0dd53b741..f282b6608 100644 --- a/docs/models/operations/listorganizationmembersresponse.mdx +++ b/docs/models/operations/listorganizationmembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListOrganizationMembersResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Result` | [operations.ListOrganizationMembersResponseBody](../../models/operations/listorganizationmembersresponsebody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Result` | [operations.ListOrganizationMembersResponseBody](../../models/operations/listorganizationmembersresponsebody.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponsebody.mdx b/docs/models/operations/listorganizationmembersresponsebody.mdx index 89160146d..ca3696304 100644 --- a/docs/models/operations/listorganizationmembersresponsebody.mdx +++ b/docs/models/operations/listorganizationmembersresponsebody.mdx @@ -9,5 +9,5 @@ List of organization members | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Data` | [][operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata.mdx) | :heavy_check_mark: | List of organization members | | -| `TotalCount` | `int64` | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file +| `Data` | [][operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata.mdx) | ✅ | List of organization members | | +| `TotalCount` | `int64` | ✅ | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/docs/models/operations/listpresetsrequest.mdx b/docs/models/operations/listpresetsrequest.mdx index 68006e47c..fd403ef08 100644 --- a/docs/models/operations/listpresetsrequest.mdx +++ b/docs/models/operations/listpresetsrequest.mdx @@ -6,5 +6,5 @@ title: "ListPresetsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listpresetsresponse.mdx b/docs/models/operations/listpresetsresponse.mdx index b2f448b8b..2ee844986 100644 --- a/docs/models/operations/listpresetsresponse.mdx +++ b/docs/models/operations/listpresetsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.ListPresetsResponse](../../models/components/listpresetsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListPresetsResponse](../../models/components/listpresetsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listpresetversionsrequest.mdx b/docs/models/operations/listpresetversionsrequest.mdx index b87256d7c..69dec98bb 100644 --- a/docs/models/operations/listpresetversionsrequest.mdx +++ b/docs/models/operations/listpresetversionsrequest.mdx @@ -6,6 +6,6 @@ title: "ListPresetVersionsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listpresetversionsresponse.mdx b/docs/models/operations/listpresetversionsresponse.mdx index 1e9724a33..6fdd0c2a4 100644 --- a/docs/models/operations/listpresetversionsresponse.mdx +++ b/docs/models/operations/listpresetversionsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetVersionsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.ListPresetVersionsResponse](../../models/components/listpresetversionsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListPresetVersionsResponse](../../models/components/listpresetversionsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listprovidersdata.mdx b/docs/models/operations/listprovidersdata.mdx index d3a2945a0..f1695d299 100644 --- a/docs/models/operations/listprovidersdata.mdx +++ b/docs/models/operations/listprovidersdata.mdx @@ -6,10 +6,10 @@ title: "ListProvidersData" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Datacenters` | optionalnullable.OptionalNullable[[][operations.Datacenter](../../models/operations/datacenter.mdx)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `Headquarters` | optionalnullable.OptionalNullable[[operations.Headquarters](../../models/operations/headquarters.mdx)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | -| `Name` | `string` | :heavy_check_mark: | Display name of the provider | OpenAI | -| `PrivacyPolicyURL` | `*string` | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | -| `Slug` | `string` | :heavy_check_mark: | URL-friendly identifier for the provider | openai | -| `StatusPageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | -| `TermsOfServiceURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file +| `Datacenters` | optionalnullable.OptionalNullable[[][operations.Datacenter](../../models/operations/datacenter.mdx)] | ➖ | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | +| `Headquarters` | optionalnullable.OptionalNullable[[operations.Headquarters](../../models/operations/headquarters.mdx)] | ➖ | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | +| `Name` | `string` | ✅ | Display name of the provider | OpenAI | +| `PrivacyPolicyURL` | `*string` | ✅ | URL to the provider's privacy policy | https://openai.com/privacy | +| `Slug` | `string` | ✅ | URL-friendly identifier for the provider | openai | +| `StatusPageURL` | optionalnullable.OptionalNullable[`string`] | ➖ | URL to the provider's status page | https://status.openai.com | +| `TermsOfServiceURL` | optionalnullable.OptionalNullable[`string`] | ➖ | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file diff --git a/docs/models/operations/listprovidersresponse.mdx b/docs/models/operations/listprovidersresponse.mdx index d691c6018..d2a4f58e7 100644 --- a/docs/models/operations/listprovidersresponse.mdx +++ b/docs/models/operations/listprovidersresponse.mdx @@ -9,4 +9,4 @@ Returns a list of providers | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Data` | [][operations.ListProvidersData](../../models/operations/listprovidersdata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][operations.ListProvidersData](../../models/operations/listprovidersdata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listrequest.mdx b/docs/models/operations/listrequest.mdx index 6c701d095..9c14a6caf 100644 --- a/docs/models/operations/listrequest.mdx +++ b/docs/models/operations/listrequest.mdx @@ -6,7 +6,7 @@ title: "ListRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `IncludeDisabled` | `*bool` | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `IncludeExpired` | `*bool` | :heavy_minus_sign: | Whether to include expired API keys in the response. Expired keys are excluded by default and returned only when this is true. | false | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `IncludeDisabled` | `*bool` | ➖ | Whether to include disabled API keys in the response | false | +| `IncludeExpired` | `*bool` | ➖ | Whether to include expired API keys in the response. Expired keys are excluded by default and returned only when this is true. | false | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of API keys to skip for pagination | 0 | +| `WorkspaceID` | `*string` | ➖ | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listresponse.mdx b/docs/models/operations/listresponse.mdx index 43ab0b4e8..cb8d6a829 100644 --- a/docs/models/operations/listresponse.mdx +++ b/docs/models/operations/listresponse.mdx @@ -9,4 +9,4 @@ List of API keys | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `Data` | [][operations.ListData](../../models/operations/listdata.mdx) | :heavy_check_mark: | List of API keys | \ No newline at end of file +| `Data` | [][operations.ListData](../../models/operations/listdata.mdx) | ✅ | List of API keys | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupmappingsrequest.mdx b/docs/models/operations/listscimgroupmappingsrequest.mdx index 4a97e8a5d..68638e51c 100644 --- a/docs/models/operations/listscimgroupmappingsrequest.mdx +++ b/docs/models/operations/listscimgroupmappingsrequest.mdx @@ -6,5 +6,5 @@ title: "ListScimGroupMappingsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupmappingsresponse.mdx b/docs/models/operations/listscimgroupmappingsresponse.mdx index 1724a2112..171a46add 100644 --- a/docs/models/operations/listscimgroupmappingsresponse.mdx +++ b/docs/models/operations/listscimgroupmappingsresponse.mdx @@ -6,4 +6,4 @@ title: "ListScimGroupMappingsResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListScimGroupMappingsResponse](../../models/components/listscimgroupmappingsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Result` | [components.ListScimGroupMappingsResponse](../../models/components/listscimgroupmappingsresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupsrequest.mdx b/docs/models/operations/listscimgroupsrequest.mdx index e5c722c5e..f01cc1b95 100644 --- a/docs/models/operations/listscimgroupsrequest.mdx +++ b/docs/models/operations/listscimgroupsrequest.mdx @@ -6,7 +6,7 @@ title: "ListScimGroupsRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `DisplayName` | `*string` | :heavy_minus_sign: | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | -| `ExternalID` | `*string` | :heavy_minus_sign: | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `DisplayName` | `*string` | ➖ | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | +| `ExternalID` | `*string` | ➖ | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupsresponse.mdx b/docs/models/operations/listscimgroupsresponse.mdx index 95eac2366..17746edcc 100644 --- a/docs/models/operations/listscimgroupsresponse.mdx +++ b/docs/models/operations/listscimgroupsresponse.mdx @@ -6,4 +6,4 @@ title: "ListScimGroupsResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Result` | [components.ListScimGroupsResponse](../../models/components/listscimgroupsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Result` | [components.ListScimGroupsResponse](../../models/components/listscimgroupsresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listtoolsrequest.mdx b/docs/models/operations/listtoolsrequest.mdx index aea2db8b1..a5a2efd67 100644 --- a/docs/models/operations/listtoolsrequest.mdx +++ b/docs/models/operations/listtoolsrequest.mdx @@ -6,6 +6,6 @@ title: "ListToolsRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `APIFormat` | [*operations.APIFormat](../../models/operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `APIFormat` | [*operations.APIFormat](../../models/operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | \ No newline at end of file diff --git a/docs/models/operations/listtoolssecurity.mdx b/docs/models/operations/listtoolssecurity.mdx index 5047967a3..0653853e7 100644 --- a/docs/models/operations/listtoolssecurity.mdx +++ b/docs/models/operations/listtoolssecurity.mdx @@ -6,4 +6,4 @@ title: "ListToolsSecurity" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `Bearer` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Bearer` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listvaultsecretsrequest.mdx b/docs/models/operations/listvaultsecretsrequest.mdx index 404a4739c..6af570247 100644 --- a/docs/models/operations/listvaultsecretsrequest.mdx +++ b/docs/models/operations/listvaultsecretsrequest.mdx @@ -6,5 +6,5 @@ title: "ListVaultSecretsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `Offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `Limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `Offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listvideoscontentrequest.mdx b/docs/models/operations/listvideoscontentrequest.mdx index 811aed19b..00317678a 100644 --- a/docs/models/operations/listvideoscontentrequest.mdx +++ b/docs/models/operations/listvideoscontentrequest.mdx @@ -6,5 +6,5 @@ title: "ListVideosContentRequest" | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `JobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | -| `Index` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file +| `JobID` | `string` | ✅ | N/A | job-abc123 | +| `Index` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | 0 | \ No newline at end of file diff --git a/docs/models/operations/listworkspacebudgetsrequest.mdx b/docs/models/operations/listworkspacebudgetsrequest.mdx index 285ebe836..27445053b 100644 --- a/docs/models/operations/listworkspacebudgetsrequest.mdx +++ b/docs/models/operations/listworkspacebudgetsrequest.mdx @@ -6,4 +6,4 @@ title: "ListWorkspaceBudgetsRequest" | Field | Type | Required | Description | Example | | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `WorkspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `WorkspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersrequest.mdx b/docs/models/operations/listworkspacemembersrequest.mdx index 1d615f5d3..b079e7468 100644 --- a/docs/models/operations/listworkspacemembersrequest.mdx +++ b/docs/models/operations/listworkspacemembersrequest.mdx @@ -6,6 +6,6 @@ title: "ListWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersresponse.mdx b/docs/models/operations/listworkspacemembersresponse.mdx index 6aea6b68f..b431f77fb 100644 --- a/docs/models/operations/listworkspacemembersresponse.mdx +++ b/docs/models/operations/listworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListWorkspaceMembersResponse](../../models/components/listworkspacemembersresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"id": "660e8400-e29b-41d4-a716-446655440000",
"role": "member",
"user_id": "user_abc123",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListWorkspaceMembersResponse](../../models/components/listworkspacemembersresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"id": "660e8400-e29b-41d4-a716-446655440000",
"role": "member",
"user_id": "user_abc123",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listworkspacesrequest.mdx b/docs/models/operations/listworkspacesrequest.mdx index ce7543051..a06c56edc 100644 --- a/docs/models/operations/listworkspacesrequest.mdx +++ b/docs/models/operations/listworkspacesrequest.mdx @@ -6,5 +6,5 @@ title: "ListWorkspacesRequest" | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `Offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `Limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listworkspacesresponse.mdx b/docs/models/operations/listworkspacesresponse.mdx index 856a6e210..cadbd892f 100644 --- a/docs/models/operations/listworkspacesresponse.mdx +++ b/docs/models/operations/listworkspacesresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListWorkspacesResponse](../../models/components/listworkspacesresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
}
],
"total_count": 1
} | \ No newline at end of file +| `Result` | [components.ListWorkspacesResponse](../../models/components/listworkspacesresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/metadata.mdx b/docs/models/operations/metadata.mdx index 60f9878f4..661a437ef 100644 --- a/docs/models/operations/metadata.mdx +++ b/docs/models/operations/metadata.mdx @@ -6,6 +6,6 @@ title: "Metadata" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `QueryTimeMs` | `float64` | :heavy_check_mark: | N/A | -| `RowCount` | `int64` | :heavy_check_mark: | N/A | -| `Truncated` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file +| `QueryTimeMs` | `float64` | ✅ | N/A | +| `RowCount` | `int64` | ✅ | N/A | +| `Truncated` | `bool` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/metric.mdx b/docs/models/operations/metric.mdx index 9c983230a..3c7114eba 100644 --- a/docs/models/operations/metric.mdx +++ b/docs/models/operations/metric.mdx @@ -6,7 +6,7 @@ title: "Metric" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `DisplayFormat` | [operations.DisplayFormat](../../models/operations/displayformat.mdx) | :heavy_check_mark: | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | -| `DisplayLabel` | `string` | :heavy_check_mark: | Human-readable label | Request Count | -| `IsRate` | `bool` | :heavy_check_mark: | Whether this metric is a rate/ratio (averaged, not summed) | | -| `Name` | `string` | :heavy_check_mark: | Metric identifier used in query requests | request_count | \ No newline at end of file +| `DisplayFormat` | [operations.DisplayFormat](../../models/operations/displayformat.mdx) | ✅ | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | +| `DisplayLabel` | `string` | ✅ | Human-readable label | Request Count | +| `IsRate` | `bool` | ✅ | Whether this metric is a rate/ratio (averaged, not summed) | | +| `Name` | `string` | ✅ | Metric identifier used in query requests | request_count | \ No newline at end of file diff --git a/docs/models/operations/operator.mdx b/docs/models/operations/operator.mdx index 786e56b5d..5ce4c9608 100644 --- a/docs/models/operations/operator.mdx +++ b/docs/models/operations/operator.mdx @@ -6,5 +6,5 @@ title: "Operator" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Name` | [operations.OperatorName](../../models/operations/operatorname.mdx) | :heavy_check_mark: | Operator identifier used in filter definitions | eq | -| `ValueType` | [operations.ValueType](../../models/operations/valuetype.mdx) | :heavy_check_mark: | Whether the operator expects a single value or an array | | \ No newline at end of file +| `Name` | [operations.OperatorName](../../models/operations/operatorname.mdx) | ✅ | Operator identifier used in filter definitions | eq | +| `ValueType` | [operations.ValueType](../../models/operations/valuetype.mdx) | ✅ | Whether the operator expects a single value or an array | | \ No newline at end of file diff --git a/docs/models/operations/orderby.mdx b/docs/models/operations/orderby.mdx index ddf319027..2b32e6627 100644 --- a/docs/models/operations/orderby.mdx +++ b/docs/models/operations/orderby.mdx @@ -6,5 +6,5 @@ title: "OrderBy" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Direction` | [operations.Direction](../../models/operations/direction.mdx) | :heavy_check_mark: | N/A | | -| `Field` | `string` | :heavy_check_mark: | Field to order by: a metric included in `metrics` (or "request_count", which may be ordered by without being requested), a requested dimension, or "date". | request_count | \ No newline at end of file +| `Direction` | [operations.Direction](../../models/operations/direction.mdx) | ✅ | N/A | | +| `Field` | `string` | ✅ | Field to order by: a metric included in `metrics` (or "request_count", which may be ordered by without being requested), a requested dimension, or "date". | request_count | \ No newline at end of file diff --git a/docs/models/operations/promotecontainerfilerequest.mdx b/docs/models/operations/promotecontainerfilerequest.mdx index 4b11aa693..88430dcc3 100644 --- a/docs/models/operations/promotecontainerfilerequest.mdx +++ b/docs/models/operations/promotecontainerfilerequest.mdx @@ -6,5 +6,5 @@ title: "PromoteContainerFileRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContainerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `FileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `ContainerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `FileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/prompttokensdetails.mdx b/docs/models/operations/prompttokensdetails.mdx index 2e4644f4b..9002770fa 100644 --- a/docs/models/operations/prompttokensdetails.mdx +++ b/docs/models/operations/prompttokensdetails.mdx @@ -9,8 +9,8 @@ Per-modality token breakdown. Only present when the input contains 2+ modalities | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `AudioTokens` | `*int64` | :heavy_minus_sign: | Number of audio tokens in the input | | -| `FileTokens` | `*int64` | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `ImageTokens` | `*int64` | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `TextTokens` | `*int64` | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `VideoTokens` | `*int64` | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file +| `AudioTokens` | `*int64` | ➖ | Number of audio tokens in the input | | +| `FileTokens` | `*int64` | ➖ | Number of file/document tokens in the input | | +| `ImageTokens` | `*int64` | ➖ | Number of image tokens in the input | 258 | +| `TextTokens` | `*int64` | ➖ | Number of text tokens in the input | 8 | +| `VideoTokens` | `*int64` | ➖ | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/models/operations/provisioninternrequest.mdx b/docs/models/operations/provisioninternrequest.mdx index c8e0762ca..95d772496 100644 --- a/docs/models/operations/provisioninternrequest.mdx +++ b/docs/models/operations/provisioninternrequest.mdx @@ -6,4 +6,4 @@ title: "ProvisionInternRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsdata2.mdx b/docs/models/operations/queryanalyticsdata2.mdx index 659d18b72..6bc62f306 100644 --- a/docs/models/operations/queryanalyticsdata2.mdx +++ b/docs/models/operations/queryanalyticsdata2.mdx @@ -6,7 +6,7 @@ title: "QueryAnalyticsData2" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CachedAt` | `*float64` | :heavy_minus_sign: | N/A | -| `Data` | [][operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1.mdx) | :heavy_check_mark: | N/A | -| `Metadata` | [operations.Metadata](../../models/operations/metadata.mdx) | :heavy_check_mark: | N/A | -| `Warnings` | []`string` | :heavy_minus_sign: | Warnings about filter resolution issues (e.g. unresolvable api_key_id hashes). The query still runs normally; these inform the caller that some filter values could not be resolved. | \ No newline at end of file +| `CachedAt` | `*float64` | ➖ | N/A | +| `Data` | [][operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1.mdx) | ✅ | N/A | +| `Metadata` | [operations.Metadata](../../models/operations/metadata.mdx) | ✅ | N/A | +| `Warnings` | []`string` | ➖ | Warnings about filter resolution issues (e.g. unresolvable api_key_id hashes). The query still runs normally; these inform the caller that some filter values could not be resolved. | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsrequest.mdx b/docs/models/operations/queryanalyticsrequest.mdx index 8d6ace311..a3fa0d328 100644 --- a/docs/models/operations/queryanalyticsrequest.mdx +++ b/docs/models/operations/queryanalyticsrequest.mdx @@ -6,13 +6,13 @@ title: "QueryAnalyticsRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClassifierDimensions` | [*operations.ClassifierDimensions](../../models/operations/classifierdimensions.mdx) | :heavy_minus_sign: | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | -| `ClassifierFilters` | [*operations.ClassifierFilters](../../models/operations/classifierfilters.mdx) | :heavy_minus_sign: | Filter results to generations with specific classifier tag values. Can be combined with classifier_dimensions (must use the same classifier_id) or used independently with standard dimensions. | | -| `Dimensions` | []`string` | :heavy_minus_sign: | N/A | | -| `Filters` | [][operations.Filter](../../models/operations/filter.mdx) | :heavy_minus_sign: | N/A | | -| `Granularity` | `*string` | :heavy_minus_sign: | Time granularity | day | -| `GroupLimit` | `*int64` | :heavy_minus_sign: | Maximum rows per distinct combination of dimensions. When omitted on time-series queries (granularity + dimensions), auto-computed to avoid truncating time windows. Explicit values override the default and may truncate time buckets if set lower than the number of buckets in the range. Ignored when no dimensions are specified. | 100 | -| `Limit` | `*int64` | :heavy_minus_sign: | Maximum total rows returned. Defaults to 1000. On time-series queries with dimensions and no explicit group_limit, the server may raise this to accommodate the expected number of unique time-bucket/dimension combinations. | | -| `Metrics` | []`string` | :heavy_check_mark: | N/A | | -| `OrderBy` | [*operations.OrderBy](../../models/operations/orderby.mdx) | :heavy_minus_sign: | N/A | | -| `TimeRange` | [*operations.TimeRange](../../models/operations/timerange.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `ClassifierDimensions` | [*operations.ClassifierDimensions](../../models/operations/classifierdimensions.mdx) | ➖ | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | +| `ClassifierFilters` | [*operations.ClassifierFilters](../../models/operations/classifierfilters.mdx) | ➖ | Filter results to generations with specific classifier tag values. Can be combined with classifier_dimensions (must use the same classifier_id) or used independently with standard dimensions. | | +| `Dimensions` | []`string` | ➖ | N/A | | +| `Filters` | [][operations.Filter](../../models/operations/filter.mdx) | ➖ | N/A | | +| `Granularity` | `*string` | ➖ | Time granularity | day | +| `GroupLimit` | `*int64` | ➖ | Maximum rows per distinct combination of dimensions. When omitted on time-series queries (granularity + dimensions), auto-computed to avoid truncating time windows. Explicit values override the default and may truncate time buckets if set lower than the number of buckets in the range. Ignored when no dimensions are specified. | 100 | +| `Limit` | `*int64` | ➖ | Maximum total rows returned. Defaults to 1000. On time-series queries with dimensions and no explicit group_limit, the server may raise this to accommodate the expected number of unique time-bucket/dimension combinations. | | +| `Metrics` | []`string` | ✅ | N/A | | +| `OrderBy` | [*operations.OrderBy](../../models/operations/orderby.mdx) | ➖ | N/A | | +| `TimeRange` | [*operations.TimeRange](../../models/operations/timerange.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsresponse.mdx b/docs/models/operations/queryanalyticsresponse.mdx index 1480df4ab..96c8f451d 100644 --- a/docs/models/operations/queryanalyticsresponse.mdx +++ b/docs/models/operations/queryanalyticsresponse.mdx @@ -9,4 +9,4 @@ Analytics query results | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Data` | [operations.QueryAnalyticsData2](../../models/operations/queryanalyticsdata2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [operations.QueryAnalyticsData2](../../models/operations/queryanalyticsdata2.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/ratelimit.mdx b/docs/models/operations/ratelimit.mdx index f9429824d..8766c1733 100644 --- a/docs/models/operations/ratelimit.mdx +++ b/docs/models/operations/ratelimit.mdx @@ -4,13 +4,13 @@ title: "~~RateLimit~~" Legacy rate limit information about a key. Will always return -1. -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Fields | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `Interval` | `string` | :heavy_check_mark: | Rate limit interval | 1h | -| `Note` | `string` | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | -| `Requests` | `int64` | :heavy_check_mark: | Number of requests allowed per interval | 1000 | \ No newline at end of file +| `Interval` | `string` | ✅ | Rate limit interval | 1h | +| `Note` | `string` | ✅ | Note about the rate limit | This field is deprecated and safe to ignore. | +| `Requests` | `int64` | ✅ | Number of requests allowed per interval | 1000 | \ No newline at end of file diff --git a/docs/models/operations/result.mdx b/docs/models/operations/result.mdx index 6a3ad02a4..8786c01d0 100644 --- a/docs/models/operations/result.mdx +++ b/docs/models/operations/result.mdx @@ -9,6 +9,6 @@ A single rerank result | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Document` | [operations.DocumentResponse](../../models/operations/documentresponse.mdx) | :heavy_check_mark: | The document object echoing the original input (text and/or image) | | -| `Index` | `int64` | :heavy_check_mark: | Index of the document in the original input list | 0 | -| `RelevanceScore` | `float64` | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file +| `Document` | [operations.DocumentResponse](../../models/operations/documentresponse.mdx) | ✅ | The document object echoing the original input (text and/or image) | | +| `Index` | `int64` | ✅ | Index of the document in the original input list | 0 | +| `RelevanceScore` | `float64` | ✅ | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/docs/models/operations/sendchatcompletionrequestrequest.mdx b/docs/models/operations/sendchatcompletionrequestrequest.mdx index c0c00e2aa..60c0fab93 100644 --- a/docs/models/operations/sendchatcompletionrequestrequest.mdx +++ b/docs/models/operations/sendchatcompletionrequestrequest.mdx @@ -6,5 +6,5 @@ title: "SendChatCompletionRequestRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file +| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/signinterndaemonaccessrequestrequest.mdx b/docs/models/operations/signinterndaemonaccessrequestrequest.mdx index ffed5a92f..87cbe8857 100644 --- a/docs/models/operations/signinterndaemonaccessrequestrequest.mdx +++ b/docs/models/operations/signinterndaemonaccessrequestrequest.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonAccessRequestRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `SignInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `SignInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/signinterndaemonaccessrequestresponse.mdx b/docs/models/operations/signinterndaemonaccessrequestresponse.mdx index 3d66673bc..e5d118fb5 100644 --- a/docs/models/operations/signinterndaemonaccessrequestresponse.mdx +++ b/docs/models/operations/signinterndaemonaccessrequestresponse.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonAccessRequestResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | | -| `Result` | [components.SignInternDaemonResponse](../../models/components/signinterndaemonresponse.mdx) | :heavy_check_mark: | N/A | \{
"x-ori-invoke-signature": "MEUCIQ...",
"x-ori-invoke-timestamp": "1789000000",
"x-ori-invoke-user": "user_2abc"
} | \ No newline at end of file +| `Headers` | map[string][]`string` | ✅ | N/A | | +| `Result` | [components.SignInternDaemonResponse](../../models/components/signinterndaemonresponse.mdx) | ✅ | N/A | \{
"x-ori-invoke-signature": "MEUCIQ...",
"x-ori-invoke-timestamp": "1789000000",
"x-ori-invoke-user": "user_2abc"
} | \ No newline at end of file diff --git a/docs/models/operations/signinterndaemonrequestrequest.mdx b/docs/models/operations/signinterndaemonrequestrequest.mdx index 0cdf914aa..e8f7436c8 100644 --- a/docs/models/operations/signinterndaemonrequestrequest.mdx +++ b/docs/models/operations/signinterndaemonrequestrequest.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonRequestRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `SignInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `SignInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/signinterndaemonrequestresponse.mdx b/docs/models/operations/signinterndaemonrequestresponse.mdx index f69184d98..32b5e602b 100644 --- a/docs/models/operations/signinterndaemonrequestresponse.mdx +++ b/docs/models/operations/signinterndaemonrequestresponse.mdx @@ -6,5 +6,5 @@ title: "SignInternDaemonRequestResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `Headers` | map[string][]`string` | :heavy_check_mark: | N/A | | -| `Result` | [components.SignInternDaemonResponse](../../models/components/signinterndaemonresponse.mdx) | :heavy_check_mark: | N/A | \{
"x-ori-invoke-signature": "MEUCIQ...",
"x-ori-invoke-timestamp": "1789000000",
"x-ori-invoke-user": "user_2abc"
} | \ No newline at end of file +| `Headers` | map[string][]`string` | ✅ | N/A | | +| `Result` | [components.SignInternDaemonResponse](../../models/components/signinterndaemonresponse.mdx) | ✅ | N/A | \{
"x-ori-invoke-signature": "MEUCIQ...",
"x-ori-invoke-timestamp": "1789000000",
"x-ori-invoke-user": "user_2abc"
} | \ No newline at end of file diff --git a/docs/models/operations/storeinternvaultsecretrequest.mdx b/docs/models/operations/storeinternvaultsecretrequest.mdx index e1a5e3553..9e07cd195 100644 --- a/docs/models/operations/storeinternvaultsecretrequest.mdx +++ b/docs/models/operations/storeinternvaultsecretrequest.mdx @@ -6,6 +6,6 @@ title: "StoreInternVaultSecretRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `Name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `VaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `InternID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `Name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `VaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file diff --git a/docs/models/operations/storevaultsecretrequest.mdx b/docs/models/operations/storevaultsecretrequest.mdx index cb88f034d..b003c000b 100644 --- a/docs/models/operations/storevaultsecretrequest.mdx +++ b/docs/models/operations/storevaultsecretrequest.mdx @@ -6,5 +6,5 @@ title: "StoreVaultSecretRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `VaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `Name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `VaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file diff --git a/docs/models/operations/suspendinternrequest.mdx b/docs/models/operations/suspendinternrequest.mdx index 8c236941f..13ed51bfc 100644 --- a/docs/models/operations/suspendinternrequest.mdx +++ b/docs/models/operations/suspendinternrequest.mdx @@ -6,4 +6,4 @@ title: "SuspendInternRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/timerange.mdx b/docs/models/operations/timerange.mdx index b8a3d5f87..36ae7e8ee 100644 --- a/docs/models/operations/timerange.mdx +++ b/docs/models/operations/timerange.mdx @@ -6,5 +6,5 @@ title: "TimeRange" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `End` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `Start` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | \ No newline at end of file +| `End` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `Start` | [time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/docs/models/operations/updatebyokkeyrequest.mdx b/docs/models/operations/updatebyokkeyrequest.mdx index bc1e0e9cf..3260099e3 100644 --- a/docs/models/operations/updatebyokkeyrequest.mdx +++ b/docs/models/operations/updatebyokkeyrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `UpdateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file +| `ID` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `UpdateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | ✅ | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file diff --git a/docs/models/operations/updateenduserrequest.mdx b/docs/models/operations/updateenduserrequest.mdx index 08747ded8..69d5214a0 100644 --- a/docs/models/operations/updateenduserrequest.mdx +++ b/docs/models/operations/updateenduserrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateEndUserRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `User` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | -| `UpdateEndUserRequest` | [components.UpdateEndUserRequest](../../models/components/updateenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"is_active": true
} | \ No newline at end of file +| `User` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `UpdateEndUserRequest` | [components.UpdateEndUserRequest](../../models/components/updateenduserrequest.mdx) | ✅ | N/A | \{
"is_active": true
} | \ No newline at end of file diff --git a/docs/models/operations/updateguardrailrequest.mdx b/docs/models/operations/updateguardrailrequest.mdx index 696bfa2bf..7a1eb0704 100644 --- a/docs/models/operations/updateguardrailrequest.mdx +++ b/docs/models/operations/updateguardrailrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `UpdateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | \ No newline at end of file +| `ID` | `string` | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `UpdateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | ✅ | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | \ No newline at end of file diff --git a/docs/models/operations/updateinternrequest.mdx b/docs/models/operations/updateinternrequest.mdx index b2246f46c..0224581ca 100644 --- a/docs/models/operations/updateinternrequest.mdx +++ b/docs/models/operations/updateinternrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateInternRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `InternID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `UpdateInternRequest` | [components.UpdateInternRequest](../../models/components/updateinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file +| `InternID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `UpdateInternRequest` | [components.UpdateInternRequest](../../models/components/updateinternrequest.mdx) | ✅ | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file diff --git a/docs/models/operations/updatekeysdata.mdx b/docs/models/operations/updatekeysdata.mdx index f54cdf5f8..eff153a50 100644 --- a/docs/models/operations/updatekeysdata.mdx +++ b/docs/models/operations/updatekeysdata.mdx @@ -9,26 +9,26 @@ The updated API key information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `BYOKUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `BYOKUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `BYOKUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `BYOKUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `ExternalUser` | `*string` | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeBYOKInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `BYOKUsage` | `float64` | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `BYOKUsageDaily` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `BYOKUsageMonthly` | `float64` | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `BYOKUsageWeekly` | `float64` | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `CreatedAt` | `string` | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `CreatorUserID` | `*string` | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `Disabled` | `bool` | ✅ | Whether the API key is disabled | false | +| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `ExternalUser` | `*string` | ✅ | Partner's end-user identifier used for attribution. | null | +| `Hash` | `string` | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `IncludeBYOKInLimit` | `bool` | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `Label` | `string` | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `LastUsedAt` | [*time.Time](https://pkg.go.dev/time#Time) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `Limit` | `*float64` | ✅ | Spending limit for the API key in USD | 100 | +| `LimitRemaining` | `*float64` | ✅ | Remaining spending limit in USD | 74.5 | +| `LimitReset` | `*string` | ✅ | Type of limit reset for the API key | monthly | +| `Name` | `string` | ✅ | Name of the API key | My Production Key | +| `UpdatedAt` | `*string` | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `Usage` | `float64` | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `UsageDaily` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `UsageMonthly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `UsageWeekly` | `float64` | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `WorkspaceID` | `string` | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/updatekeysrequest.mdx b/docs/models/operations/updatekeysrequest.mdx index b77a48fae..ea4ecae6d 100644 --- a/docs/models/operations/updatekeysrequest.mdx +++ b/docs/models/operations/updatekeysrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `RequestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | \ No newline at end of file +| `Hash` | `string` | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `RequestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | ✅ | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | \ No newline at end of file diff --git a/docs/models/operations/updatekeysrequestbody.mdx b/docs/models/operations/updatekeysrequestbody.mdx index d311f277d..15a52daf8 100644 --- a/docs/models/operations/updatekeysrequestbody.mdx +++ b/docs/models/operations/updatekeysrequestbody.mdx @@ -6,8 +6,8 @@ title: "UpdateKeysRequestBody" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Disabled` | `*bool` | :heavy_minus_sign: | Whether to disable the API key | false | -| `IncludeBYOKInLimit` | `*bool` | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `Limit` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `LimitReset` | optionalnullable.OptionalNullable[[operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset.mdx)] | :heavy_minus_sign: | New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | daily | -| `Name` | `*string` | :heavy_minus_sign: | New name for the API key | Updated API Key Name | \ No newline at end of file +| `Disabled` | `*bool` | ➖ | Whether to disable the API key | false | +| `IncludeBYOKInLimit` | `*bool` | ➖ | Whether to include BYOK usage in the limit | true | +| `Limit` | optionalnullable.OptionalNullable[`float64`] | ➖ | New spending limit for the API key in USD | 75 | +| `LimitReset` | optionalnullable.OptionalNullable[[operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset.mdx)] | ➖ | New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | daily | +| `Name` | `*string` | ➖ | New name for the API key | Updated API Key Name | \ No newline at end of file diff --git a/docs/models/operations/updatekeysresponse.mdx b/docs/models/operations/updatekeysresponse.mdx index 540395465..16e18855a 100644 --- a/docs/models/operations/updatekeysresponse.mdx +++ b/docs/models/operations/updatekeysresponse.mdx @@ -9,4 +9,4 @@ API key updated successfully | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [operations.UpdateKeysData](../../models/operations/updatekeysdata.mdx) | :heavy_check_mark: | The updated API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `Data` | [operations.UpdateKeysData](../../models/operations/updatekeysdata.mdx) | ✅ | The updated API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/operations/updateobservabilitydestinationrequest.mdx b/docs/models/operations/updateobservabilitydestinationrequest.mdx index a32db161a..c85bd7dfa 100644 --- a/docs/models/operations/updateobservabilitydestinationrequest.mdx +++ b/docs/models/operations/updateobservabilitydestinationrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `UpdateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file +| `ID` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `UpdateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file diff --git a/docs/models/operations/updateorganizationsettingsresponse.mdx b/docs/models/operations/updateorganizationsettingsresponse.mdx index d635bc072..fedc16e52 100644 --- a/docs/models/operations/updateorganizationsettingsresponse.mdx +++ b/docs/models/operations/updateorganizationsettingsresponse.mdx @@ -9,4 +9,4 @@ Organization settings updated successfully | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.OrganizationSettings](../../models/components/organizationsettings.mdx) | :heavy_check_mark: | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file +| `Data` | [components.OrganizationSettings](../../models/components/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file diff --git a/docs/models/operations/updateprivateendpointpricingrequest.mdx b/docs/models/operations/updateprivateendpointpricingrequest.mdx index 187463d9b..dfa3c50f1 100644 --- a/docs/models/operations/updateprivateendpointpricingrequest.mdx +++ b/docs/models/operations/updateprivateendpointpricingrequest.mdx @@ -6,5 +6,5 @@ title: "UpdatePrivateEndpointPricingRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `UpdatePrivateEndpointPricingRequest` | [components.UpdatePrivateEndpointPricingRequest](../../models/components/updateprivateendpointpricingrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `UpdatePrivateEndpointPricingRequest` | [components.UpdatePrivateEndpointPricingRequest](../../models/components/updateprivateendpointpricingrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/updateprivateendpointrequest.mdx b/docs/models/operations/updateprivateendpointrequest.mdx index 41c773456..988d76d47 100644 --- a/docs/models/operations/updateprivateendpointrequest.mdx +++ b/docs/models/operations/updateprivateendpointrequest.mdx @@ -6,5 +6,5 @@ title: "UpdatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `UpdatePrivateEndpointRequest` | [components.UpdatePrivateEndpointRequest](../../models/components/updateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `UpdatePrivateEndpointRequest` | [components.UpdatePrivateEndpointRequest](../../models/components/updateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/updatescimgroupmappingrequest.mdx b/docs/models/operations/updatescimgroupmappingrequest.mdx index 4228979be..b83ad3851 100644 --- a/docs/models/operations/updatescimgroupmappingrequest.mdx +++ b/docs/models/operations/updatescimgroupmappingrequest.mdx @@ -6,5 +6,5 @@ title: "UpdateScimGroupMappingRequest" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `UpdateScimGroupMappingRequest` | [components.UpdateScimGroupMappingRequest](../../models/components/updatescimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ID` | `string` | ✅ | N/A | +| `UpdateScimGroupMappingRequest` | [components.UpdateScimGroupMappingRequest](../../models/components/updatescimgroupmappingrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/updateworkspacerequest.mdx b/docs/models/operations/updateworkspacerequest.mdx index 3403cdcee..d921d3f58 100644 --- a/docs/models/operations/updateworkspacerequest.mdx +++ b/docs/models/operations/updateworkspacerequest.mdx @@ -6,5 +6,5 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `UpdateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file +| `ID` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `UpdateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | ✅ | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file diff --git a/docs/models/operations/uploadfilefile.mdx b/docs/models/operations/uploadfilefile.mdx index 8427f36ed..078a2b7c1 100644 --- a/docs/models/operations/uploadfilefile.mdx +++ b/docs/models/operations/uploadfilefile.mdx @@ -6,5 +6,5 @@ title: "UploadFileFile" | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `FileName` | `string` | :heavy_check_mark: | N/A | -| `Content` | `any` | :heavy_check_mark: | N/A | \ No newline at end of file +| `FileName` | `string` | ✅ | N/A | +| `Content` | `any` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequest.mdx b/docs/models/operations/uploadfilerequest.mdx index 673bebcf6..bf269f386 100644 --- a/docs/models/operations/uploadfilerequest.mdx +++ b/docs/models/operations/uploadfilerequest.mdx @@ -6,6 +6,6 @@ title: "UploadFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `RequestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `WorkspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `RequestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequestbody.mdx b/docs/models/operations/uploadfilerequestbody.mdx index b16519990..9a8f78cae 100644 --- a/docs/models/operations/uploadfilerequestbody.mdx +++ b/docs/models/operations/uploadfilerequestbody.mdx @@ -6,4 +6,4 @@ title: "UploadFileRequestBody" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `File` | [operations.UploadFileFile](../../models/operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `File` | [operations.UploadFileFile](../../models/operations/uploadfilefile.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/upsertworkspacebudgetrequest.mdx b/docs/models/operations/upsertworkspacebudgetrequest.mdx index d30a305eb..d84d52215 100644 --- a/docs/models/operations/upsertworkspacebudgetrequest.mdx +++ b/docs/models/operations/upsertworkspacebudgetrequest.mdx @@ -6,6 +6,6 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `WorkspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `UpsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file +| `WorkspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `UpsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | ✅ | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file diff --git a/docs/models/operations/validateprivateendpointrequest.mdx b/docs/models/operations/validateprivateendpointrequest.mdx index 7903e1900..afc0b7231 100644 --- a/docs/models/operations/validateprivateendpointrequest.mdx +++ b/docs/models/operations/validateprivateendpointrequest.mdx @@ -6,5 +6,5 @@ title: "ValidatePrivateEndpointRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `ValidatePrivateEndpointRequest` | [components.ValidatePrivateEndpointRequest](../../models/components/validateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `ValidatePrivateEndpointRequest` | [components.ValidatePrivateEndpointRequest](../../models/components/validateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/badgatewayresponseerror.mdx b/docs/models/sdkerrors/badgatewayresponseerror.mdx index 4686d845f..0ae8aed94 100644 --- a/docs/models/sdkerrors/badgatewayresponseerror.mdx +++ b/docs/models/sdkerrors/badgatewayresponseerror.mdx @@ -9,6 +9,6 @@ Bad Gateway - Provider/upstream API failure | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Error` | [components.BadGatewayResponseErrorData](../../models/components/badgatewayresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.BadGatewayResponseErrorData](../../models/components/badgatewayresponseerrordata.mdx) | ✅ | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/badrequestresponseerror.mdx b/docs/models/sdkerrors/badrequestresponseerror.mdx index 2010057af..9f6eec8d6 100644 --- a/docs/models/sdkerrors/badrequestresponseerror.mdx +++ b/docs/models/sdkerrors/badrequestresponseerror.mdx @@ -9,6 +9,6 @@ Bad Request - Invalid request parameters or malformed input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Error` | [components.BadRequestResponseErrorData](../../models/components/badrequestresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.BadRequestResponseErrorData](../../models/components/badrequestresponseerrordata.mdx) | ✅ | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/batcherrorresponse.mdx b/docs/models/sdkerrors/batcherrorresponse.mdx index 864644026..4b6e5d63f 100644 --- a/docs/models/sdkerrors/batcherrorresponse.mdx +++ b/docs/models/sdkerrors/batcherrorresponse.mdx @@ -6,4 +6,4 @@ title: "BatchErrorResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Error` | [components.BatchErrorResponseError](../../models/components/batcherrorresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Error` | [components.BatchErrorResponseError](../../models/components/batcherrorresponseerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/batchpaymentrequiredresponseerror.mdx b/docs/models/sdkerrors/batchpaymentrequiredresponseerror.mdx index 384ea1eed..275d120cd 100644 --- a/docs/models/sdkerrors/batchpaymentrequiredresponseerror.mdx +++ b/docs/models/sdkerrors/batchpaymentrequiredresponseerror.mdx @@ -9,15 +9,15 @@ Batch metadata with results withheld (results: null) plus the standard error env | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `CompletionWindow` | [components.BatchPaymentRequiredResponseCompletionWindow](../../models/components/batchpaymentrequiredresponsecompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `CreatedAt` | `int64` | :heavy_check_mark: | N/A | -| `Endpoint` | `string` | :heavy_check_mark: | N/A | -| `Error` | [components.BatchPaymentRequiredResponseError](../../models/components/batchpaymentrequiredresponseerror.mdx) | :heavy_check_mark: | N/A | -| `FinalizedAt` | `*int64` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Object` | [components.BatchPaymentRequiredResponseObject](../../models/components/batchpaymentrequiredresponseobject.mdx) | :heavy_check_mark: | N/A | -| `RequestCounts` | [components.BatchPaymentRequiredResponseRequestCounts](../../models/components/batchpaymentrequiredresponserequestcounts.mdx) | :heavy_check_mark: | N/A | -| `Results` | `any` | :heavy_check_mark: | Always null: results are withheld until the batch charge is covered. | -| `Status` | [components.BatchPaymentRequiredResponseStatus](../../models/components/batchpaymentrequiredresponsestatus.mdx) | :heavy_check_mark: | N/A | -| `Usage` | [*components.BatchPaymentRequiredResponseUsage](../../models/components/batchpaymentrequiredresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `CompletionWindow` | [components.BatchPaymentRequiredResponseCompletionWindow](../../models/components/batchpaymentrequiredresponsecompletionwindow.mdx) | ✅ | N/A | +| `CreatedAt` | `int64` | ✅ | N/A | +| `Endpoint` | `string` | ✅ | N/A | +| `Error` | [components.BatchPaymentRequiredResponseError](../../models/components/batchpaymentrequiredresponseerror.mdx) | ✅ | N/A | +| `FinalizedAt` | `*int64` | ✅ | N/A | +| `ID` | `string` | ✅ | N/A | +| `Model` | `string` | ✅ | N/A | +| `Object` | [components.BatchPaymentRequiredResponseObject](../../models/components/batchpaymentrequiredresponseobject.mdx) | ✅ | N/A | +| `RequestCounts` | [components.BatchPaymentRequiredResponseRequestCounts](../../models/components/batchpaymentrequiredresponserequestcounts.mdx) | ✅ | N/A | +| `Results` | `any` | ✅ | Always null: results are withheld until the batch charge is covered. | +| `Status` | [components.BatchPaymentRequiredResponseStatus](../../models/components/batchpaymentrequiredresponsestatus.mdx) | ✅ | N/A | +| `Usage` | [*components.BatchPaymentRequiredResponseUsage](../../models/components/batchpaymentrequiredresponseusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/conflictresponseerror.mdx b/docs/models/sdkerrors/conflictresponseerror.mdx index a35b87986..579b25f94 100644 --- a/docs/models/sdkerrors/conflictresponseerror.mdx +++ b/docs/models/sdkerrors/conflictresponseerror.mdx @@ -9,6 +9,6 @@ Conflict - Resource conflict or concurrent modification | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.ConflictResponseErrorData](../../models/components/conflictresponseerrordata.mdx) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.ConflictResponseErrorData](../../models/components/conflictresponseerrordata.mdx) | ✅ | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/createprivateendpointvalidationfailedresponseerror.mdx b/docs/models/sdkerrors/createprivateendpointvalidationfailedresponseerror.mdx index efef1fb31..19506f39c 100644 --- a/docs/models/sdkerrors/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/models/sdkerrors/createprivateendpointvalidationfailedresponseerror.mdx @@ -6,5 +6,5 @@ title: "CreatePrivateEndpointValidationFailedResponseError" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.CreatePrivateEndpointValidationFailedResponseData](../../models/components/createprivateendpointvalidationfailedresponsedata.mdx) | :heavy_check_mark: | N/A | -| `Error` | [components.CreatePrivateEndpointValidationFailedResponseError](../../models/components/createprivateendpointvalidationfailedresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.CreatePrivateEndpointValidationFailedResponseData](../../models/components/createprivateendpointvalidationfailedresponsedata.mdx) | ✅ | N/A | +| `Error` | [components.CreatePrivateEndpointValidationFailedResponseError](../../models/components/createprivateendpointvalidationfailedresponseerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx b/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx index 18673bd40..61bfbc5c6 100644 --- a/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx +++ b/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Infrastructure Timeout - Provider request timed out at edge network | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.EdgeNetworkTimeoutResponseErrorData](../../models/components/edgenetworktimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.EdgeNetworkTimeoutResponseErrorData](../../models/components/edgenetworktimeoutresponseerrordata.mdx) | ✅ | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/forbiddenresponseerror.mdx b/docs/models/sdkerrors/forbiddenresponseerror.mdx index e4947ec51..3a025d093 100644 --- a/docs/models/sdkerrors/forbiddenresponseerror.mdx +++ b/docs/models/sdkerrors/forbiddenresponseerror.mdx @@ -9,6 +9,6 @@ Forbidden - Authentication successful but insufficient permissions | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Error` | [components.ForbiddenResponseErrorData](../../models/components/forbiddenresponseerrordata.mdx) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.ForbiddenResponseErrorData](../../models/components/forbiddenresponseerrordata.mdx) | ✅ | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/gatewaytimeoutresponseerror.mdx b/docs/models/sdkerrors/gatewaytimeoutresponseerror.mdx index feaa27a90..effefaea8 100644 --- a/docs/models/sdkerrors/gatewaytimeoutresponseerror.mdx +++ b/docs/models/sdkerrors/gatewaytimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Gateway Timeout - Provider did not respond before the upstream deadline | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.GatewayTimeoutResponseErrorData](../../models/components/gatewaytimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.GatewayTimeoutResponseErrorData](../../models/components/gatewaytimeoutresponseerrordata.mdx) | ✅ | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/goneresponseerror.mdx b/docs/models/sdkerrors/goneresponseerror.mdx index 98b5222ff..e796b5a84 100644 --- a/docs/models/sdkerrors/goneresponseerror.mdx +++ b/docs/models/sdkerrors/goneresponseerror.mdx @@ -9,6 +9,6 @@ Gone - Endpoint has been permanently removed or deprecated | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.GoneResponseErrorData](../../models/components/goneresponseerrordata.mdx) | :heavy_check_mark: | Error data for GoneResponse | \{
"code": 410,
"message": "The Coinbase APIs used by this endpoint have been deprecated, so the Coinbase Commerce credits API has been removed. Use the web credits purchase flow instead."
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.GoneResponseErrorData](../../models/components/goneresponseerrordata.mdx) | ✅ | Error data for GoneResponse | \{
"code": 410,
"message": "The Coinbase APIs used by this endpoint have been deprecated, so the Coinbase Commerce credits API has been removed. Use the web credits purchase flow instead."
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/internalserverresponseerror.mdx b/docs/models/sdkerrors/internalserverresponseerror.mdx index 30dde4738..3ab479ef6 100644 --- a/docs/models/sdkerrors/internalserverresponseerror.mdx +++ b/docs/models/sdkerrors/internalserverresponseerror.mdx @@ -9,6 +9,6 @@ Internal Server Error - Unexpected server error | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.InternalServerResponseErrorData](../../models/components/internalserverresponseerrordata.mdx) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.InternalServerResponseErrorData](../../models/components/internalserverresponseerrordata.mdx) | ✅ | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/internchaterrorresponse.mdx b/docs/models/sdkerrors/internchaterrorresponse.mdx index 069432a03..d503e45cb 100644 --- a/docs/models/sdkerrors/internchaterrorresponse.mdx +++ b/docs/models/sdkerrors/internchaterrorresponse.mdx @@ -9,4 +9,4 @@ A refusal before the stream opens. Once the response is `200` and streaming, fai | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.InternChatError](../../models/components/internchaterror.mdx) | :heavy_check_mark: | The OpenAI-compatible error object. `metadata` is present on refusals from the chat route. Authentication refusals (`401`), the departed-creator `403` and the programme `404` carry only `code` and `message`. | \{
"code": 409,
"message": "That question is no longer waiting for an answer.",
"metadata": \{
"reason": "interaction_not_pending",
"retryable": false
}
} | \ No newline at end of file +| `Error` | [components.InternChatError](../../models/components/internchaterror.mdx) | ✅ | The OpenAI-compatible error object. `metadata` is present on refusals from the chat route. Authentication refusals (`401`), the departed-creator `403` and the programme `404` carry only `code` and `message`. | \{
"code": 409,
"message": "That question is no longer waiting for an answer.",
"metadata": \{
"reason": "interaction_not_pending",
"retryable": false
}
} | \ No newline at end of file diff --git a/docs/models/sdkerrors/internlifecycleerror.mdx b/docs/models/sdkerrors/internlifecycleerror.mdx index f938a2177..a500476aa 100644 --- a/docs/models/sdkerrors/internlifecycleerror.mdx +++ b/docs/models/sdkerrors/internlifecycleerror.mdx @@ -9,4 +9,4 @@ Intern lifecycle request failure. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.InternLifecycleErrorError](../../models/components/internlifecycleerrorerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Error` | [components.InternLifecycleErrorError](../../models/components/internlifecycleerrorerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/notfoundresponseerror.mdx b/docs/models/sdkerrors/notfoundresponseerror.mdx index 5f17e90bc..d10dcaf6a 100644 --- a/docs/models/sdkerrors/notfoundresponseerror.mdx +++ b/docs/models/sdkerrors/notfoundresponseerror.mdx @@ -9,6 +9,6 @@ Not Found - Resource does not exist | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.NotFoundResponseErrorData](../../models/components/notfoundresponseerrordata.mdx) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.NotFoundResponseErrorData](../../models/components/notfoundresponseerrordata.mdx) | ✅ | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/oautherrorresponse.mdx b/docs/models/sdkerrors/oautherrorresponse.mdx index 5983e5c2c..44858fe47 100644 --- a/docs/models/sdkerrors/oautherrorresponse.mdx +++ b/docs/models/sdkerrors/oautherrorresponse.mdx @@ -9,5 +9,5 @@ RFC 6749 §5.2 error response. | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `Error` | [components.ErrorEnum](../../models/components/errorenum.mdx) | :heavy_check_mark: | N/A | -| `ErrorDescription` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file +| `Error` | [components.ErrorEnum](../../models/components/errorenum.mdx) | ✅ | N/A | +| `ErrorDescription` | `string` | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx b/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx index 9ffad6317..3435e0ef8 100644 --- a/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx +++ b/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx @@ -9,6 +9,6 @@ Payload Too Large - Request payload exceeds size limits | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.PayloadTooLargeResponseErrorData](../../models/components/payloadtoolargeresponseerrordata.mdx) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.PayloadTooLargeResponseErrorData](../../models/components/payloadtoolargeresponseerrordata.mdx) | ✅ | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/paymentrequiredresponseerror.mdx b/docs/models/sdkerrors/paymentrequiredresponseerror.mdx index 9716a4008..e1d5372e6 100644 --- a/docs/models/sdkerrors/paymentrequiredresponseerror.mdx +++ b/docs/models/sdkerrors/paymentrequiredresponseerror.mdx @@ -9,6 +9,6 @@ Payment Required - Insufficient credits or quota to complete request | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.PaymentRequiredResponseErrorData](../../models/components/paymentrequiredresponseerrordata.mdx) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.PaymentRequiredResponseErrorData](../../models/components/paymentrequiredresponseerrordata.mdx) | ✅ | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/provideroverloadedresponseerror.mdx b/docs/models/sdkerrors/provideroverloadedresponseerror.mdx index 511534530..3aa231040 100644 --- a/docs/models/sdkerrors/provideroverloadedresponseerror.mdx +++ b/docs/models/sdkerrors/provideroverloadedresponseerror.mdx @@ -9,6 +9,6 @@ Provider Overloaded - Provider is temporarily overloaded | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.ProviderOverloadedResponseErrorData](../../models/components/provideroverloadedresponseerrordata.mdx) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.ProviderOverloadedResponseErrorData](../../models/components/provideroverloadedresponseerrordata.mdx) | ✅ | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/requesttimeoutresponseerror.mdx b/docs/models/sdkerrors/requesttimeoutresponseerror.mdx index cb88e051e..0c271c702 100644 --- a/docs/models/sdkerrors/requesttimeoutresponseerror.mdx +++ b/docs/models/sdkerrors/requesttimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Request Timeout - Operation exceeded time limit | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.RequestTimeoutResponseErrorData](../../models/components/requesttimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.RequestTimeoutResponseErrorData](../../models/components/requesttimeoutresponseerrordata.mdx) | ✅ | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/serviceunavailableresponseerror.mdx b/docs/models/sdkerrors/serviceunavailableresponseerror.mdx index 5a5b3d540..57eee2f80 100644 --- a/docs/models/sdkerrors/serviceunavailableresponseerror.mdx +++ b/docs/models/sdkerrors/serviceunavailableresponseerror.mdx @@ -9,6 +9,6 @@ Service Unavailable - Service temporarily unavailable | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.ServiceUnavailableResponseErrorData](../../models/components/serviceunavailableresponseerrordata.mdx) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.ServiceUnavailableResponseErrorData](../../models/components/serviceunavailableresponseerrordata.mdx) | ✅ | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx b/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx index eb7b7d8fd..285f2986a 100644 --- a/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx +++ b/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx @@ -9,6 +9,6 @@ Too Many Requests - Rate limit exceeded | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.TooManyRequestsResponseErrorData](../../models/components/toomanyrequestsresponseerrordata.mdx) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.TooManyRequestsResponseErrorData](../../models/components/toomanyrequestsresponseerrordata.mdx) | ✅ | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/unauthorizedresponseerror.mdx b/docs/models/sdkerrors/unauthorizedresponseerror.mdx index 597ae20a5..0bade8bb6 100644 --- a/docs/models/sdkerrors/unauthorizedresponseerror.mdx +++ b/docs/models/sdkerrors/unauthorizedresponseerror.mdx @@ -9,6 +9,6 @@ Unauthorized - Authentication required or invalid credentials | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Error` | [components.UnauthorizedResponseErrorData](../../models/components/unauthorizedresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.UnauthorizedResponseErrorData](../../models/components/unauthorizedresponseerrordata.mdx) | ✅ | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/unprocessableentityresponseerror.mdx b/docs/models/sdkerrors/unprocessableentityresponseerror.mdx index 415372530..ed3137f79 100644 --- a/docs/models/sdkerrors/unprocessableentityresponseerror.mdx +++ b/docs/models/sdkerrors/unprocessableentityresponseerror.mdx @@ -9,6 +9,6 @@ Unprocessable Entity - Semantic validation failure | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Error` | [components.UnprocessableEntityResponseErrorData](../../models/components/unprocessableentityresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | -| `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Error` | [components.UnprocessableEntityResponseErrorData](../../models/components/unprocessableentityresponseerrordata.mdx) | ✅ | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | +| `OpenrouterMetadata` | map[string]`any` | ➖ | N/A | | +| `UserID` | `*string` | ➖ | N/A | | \ No newline at end of file diff --git a/docs/sdks/analytics/README.mdx b/docs/sdks/analytics/README.mdx index 84d83302a..c60d56907 100644 --- a/docs/sdks/analytics/README.mdx +++ b/docs/sdks/analytics/README.mdx @@ -50,13 +50,13 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `date` | `*string` | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `apiKeyHash` | `*string` | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `userID` | `*string` | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | -| `groupBy` | [*operations.GroupBy](../../models/operations/groupby.mdx) | :heavy_minus_sign: | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | -| `workspaceID` | `*string` | :heavy_minus_sign: | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `date` | `*string` | ➖ | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | +| `apiKeyHash` | `*string` | ➖ | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | +| `userID` | `*string` | ➖ | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | +| `groupBy` | [*operations.GroupBy](../../models/operations/groupby.mdx) | ➖ | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | +| `workspaceID` | `*string` | ➖ | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -110,8 +110,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -178,9 +178,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/apikeys/README.mdx b/docs/sdks/apikeys/README.mdx index 9b084cf94..d3469fb62 100644 --- a/docs/sdks/apikeys/README.mdx +++ b/docs/sdks/apikeys/README.mdx @@ -53,8 +53,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -106,12 +106,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `includeDisabled` | `*bool` | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `includeExpired` | `*bool` | :heavy_minus_sign: | Whether to include expired API keys in the response. Expired keys are excluded by default and returned only when this is true. | false | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | -| `workspaceID` | `*string` | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `includeDisabled` | `*bool` | ➖ | Whether to include disabled API keys in the response | false | +| `includeExpired` | `*bool` | ➖ | Whether to include expired API keys in the response. Expired keys are excluded by default and returned only when this is true. | false | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of API keys to skip for pagination | 0 | +| `workspaceID` | `*string` | ➖ | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -173,9 +173,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -229,9 +229,9 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `hash` | `string` | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -284,9 +284,9 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `hash` | `string` | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -373,10 +373,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `hash` | `string` | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | ✅ | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/batch/README.mdx b/docs/sdks/batch/README.mdx index 231563cb9..4f4c9547d 100644 --- a/docs/sdks/batch/README.mdx +++ b/docs/sdks/batch/README.mdx @@ -63,9 +63,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.ListBatchesRequest](../../models/operations/listbatchesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.ListBatchesRequest](../../models/operations/listbatchesrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -278,9 +278,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.BatchSubmitBody](../../models/components/batchsubmitbody.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.BatchSubmitBody](../../models/components/batchsubmitbody.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -331,9 +331,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The batch job id returned from submit. | batch_abc123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -384,9 +384,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The batch job id returned from submit. | batch_abc123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/benchmarks/README.mdx b/docs/sdks/benchmarks/README.mdx index 98e34c943..767f454e6 100644 --- a/docs/sdks/benchmarks/README.mdx +++ b/docs/sdks/benchmarks/README.mdx @@ -51,9 +51,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/betaresponses/README.mdx b/docs/sdks/betaresponses/README.mdx index 71d14851f..3e8ba4a68 100644 --- a/docs/sdks/betaresponses/README.mdx +++ b/docs/sdks/betaresponses/README.mdx @@ -90,10 +90,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/byok/README.mdx b/docs/sdks/byok/README.mdx index 3848c8b47..38aa9be17 100644 --- a/docs/sdks/byok/README.mdx +++ b/docs/sdks/byok/README.mdx @@ -65,12 +65,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | -| `provider` | [*operations.Provider](../../models/operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspaceID` | `*string` | ➖ | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | +| `provider` | [*operations.Provider](../../models/operations/provider.mdx) | ➖ | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -128,9 +128,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateBYOKKeyRequest](../../models/components/createbyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.CreateBYOKKeyRequest](../../models/components/createbyokkeyrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -183,9 +183,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -237,9 +237,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -296,10 +296,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `updateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `updateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | ✅ | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/chat/README.mdx b/docs/sdks/chat/README.mdx index 783551d5d..08af19533 100644 --- a/docs/sdks/chat/README.mdx +++ b/docs/sdks/chat/README.mdx @@ -125,10 +125,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/classifications/README.mdx b/docs/sdks/classifications/README.mdx index 1ba80d0ad..f6936e7a5 100644 --- a/docs/sdks/classifications/README.mdx +++ b/docs/sdks/classifications/README.mdx @@ -67,9 +67,9 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `window` | [*operations.Window](../../models/operations/window.mdx) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `window` | [*operations.Window](../../models/operations/window.mdx) | ➖ | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/containers/README.mdx b/docs/sdks/containers/README.mdx index 11013aa8d..7b968e73b 100644 --- a/docs/sdks/containers/README.mdx +++ b/docs/sdks/containers/README.mdx @@ -51,11 +51,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `containerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `after` | `*string` | :heavy_minus_sign: | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `containerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `limit` | `*int64` | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `after` | `*string` | ➖ | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -110,10 +110,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `containerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `containerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -169,10 +169,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `containerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `containerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -239,10 +239,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `containerID` | `string` | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileID` | `string` | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `containerID` | `string` | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileID` | `string` | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/credits/README.mdx b/docs/sdks/credits/README.mdx index 7ddbb546f..948523384 100644 --- a/docs/sdks/credits/README.mdx +++ b/docs/sdks/credits/README.mdx @@ -48,8 +48,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/datasets/README.mdx b/docs/sdks/datasets/README.mdx index 56b4fa796..f2439193b 100644 --- a/docs/sdks/datasets/README.mdx +++ b/docs/sdks/datasets/README.mdx @@ -87,9 +87,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -169,9 +169,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -245,9 +245,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetSessionCostRequest](../../models/operations/getsessioncostrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.GetSessionCostRequest](../../models/operations/getsessioncostrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/decisions/README.mdx b/docs/sdks/decisions/README.mdx index 35c24caa3..e4ea9c6e4 100644 --- a/docs/sdks/decisions/README.mdx +++ b/docs/sdks/decisions/README.mdx @@ -113,9 +113,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.DecisionsRequest](../../models/components/decisionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.DecisionsRequest](../../models/components/decisionsrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/embeddings/README.mdx b/docs/sdks/embeddings/README.mdx index 775d5312a..997587c02 100644 --- a/docs/sdks/embeddings/README.mdx +++ b/docs/sdks/embeddings/README.mdx @@ -55,9 +55,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -133,10 +133,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/endpoints/README.mdx b/docs/sdks/endpoints/README.mdx index 844044ad6..e9d089d67 100644 --- a/docs/sdks/endpoints/README.mdx +++ b/docs/sdks/endpoints/README.mdx @@ -49,8 +49,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -101,10 +101,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | `string` | :heavy_check_mark: | The model slug | gpt-4 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `author` | `string` | ✅ | The author/organization of the model | openai | +| `slug` | `string` | ✅ | The model slug | gpt-4 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/endusers/README.mdx b/docs/sdks/endusers/README.mdx index 32c4de712..2e65749d4 100644 --- a/docs/sdks/endusers/README.mdx +++ b/docs/sdks/endusers/README.mdx @@ -65,12 +65,12 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `user` | `*string` | :heavy_minus_sign: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | -| `includeInactive` | `*bool` | :heavy_minus_sign: | Include deactivated registrations. | false | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `user` | `*string` | ➖ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `includeInactive` | `*bool` | ➖ | Include deactivated registrations. | false | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -126,9 +126,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateEndUserRequest](../../models/components/createenduserrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.CreateEndUserRequest](../../models/components/createenduserrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -179,9 +179,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `user` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `user` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -234,9 +234,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `user` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `user` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -292,10 +292,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `user` | `string` | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | -| `updateEndUserRequest` | [components.UpdateEndUserRequest](../../models/components/updateenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"is_active": true
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `user` | `string` | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of `.` or `..` cannot be addressed by path, so look it up with the list filter. | employee_123 | +| `updateEndUserRequest` | [components.UpdateEndUserRequest](../../models/components/updateenduserrequest.mdx) | ✅ | N/A | \{
"is_active": true
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/files/README.mdx b/docs/sdks/files/README.mdx index 8087d035c..98054ffa0 100644 --- a/docs/sdks/files/README.mdx +++ b/docs/sdks/files/README.mdx @@ -68,9 +68,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -148,11 +148,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | -| `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | ✅ | N/A | | +| `workspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -220,11 +220,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `fileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `fileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -291,11 +291,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `fileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `fileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -352,11 +352,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `fileID` | `string` | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `fileID` | `string` | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceID` | `*string` | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [*components.FileProvider](../../models/components/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/generations/README.mdx b/docs/sdks/generations/README.mdx index 796f1e5d9..f4d2e84f3 100644 --- a/docs/sdks/generations/README.mdx +++ b/docs/sdks/generations/README.mdx @@ -50,9 +50,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The generation ID | gen-1234567890 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -110,9 +110,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The generation ID | gen-1234567890 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -175,9 +175,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.SubmitGenerationFeedbackRequest](../../models/components/submitgenerationfeedbackrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.SubmitGenerationFeedbackRequest](../../models/components/submitgenerationfeedbackrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/guardrails/README.mdx b/docs/sdks/guardrails/README.mdx index 6f0e6fdda..b2f6fa11d 100644 --- a/docs/sdks/guardrails/README.mdx +++ b/docs/sdks/guardrails/README.mdx @@ -73,11 +73,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceID` | `*string` | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspaceID` | `*string` | ➖ | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -152,9 +152,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateGuardrailRequest](../../models/components/createguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.CreateGuardrailRequest](../../models/components/createguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -207,9 +207,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -261,9 +261,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -322,10 +322,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `updateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `updateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | ✅ | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -393,11 +393,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -454,10 +454,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -516,10 +516,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -585,11 +585,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -647,10 +647,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -709,10 +709,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -778,10 +778,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -845,10 +845,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/images/README.mdx b/docs/sdks/images/README.mdx index 9abe56d20..0090441dc 100644 --- a/docs/sdks/images/README.mdx +++ b/docs/sdks/images/README.mdx @@ -60,9 +60,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.ImageGenerationRequest](../../models/components/imagegenerationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.ImageGenerationRequest](../../models/components/imagegenerationrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -122,8 +122,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -173,10 +173,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `author` | `string` | :heavy_check_mark: | Model author/organization | bytedance-seed | -| `slug` | `string` | :heavy_check_mark: | Model slug | seedream-4.5 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `author` | `string` | ✅ | Model author/organization | bytedance-seed | +| `slug` | `string` | ✅ | Model slug | seedream-4.5 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/interns/README.mdx b/docs/sdks/interns/README.mdx index 9a5005ead..56d6155b9 100644 --- a/docs/sdks/interns/README.mdx +++ b/docs/sdks/interns/README.mdx @@ -15,8 +15,8 @@ Create, inspect, update, provision, suspend and delete OpenRouter interns throug * [GetIntern](#getintern) - Get an intern * [UpdateIntern](#updateintern) - Update an intern * [GetInternDaemon](#getinterndaemon) - Get an intern's daemon access -* [~~GetInternDaemonAccess~~](#getinterndaemonaccess) - Get an intern's daemon access (deprecated alias) :warning: **Deprecated** -* [~~SignInternDaemonAccessRequest~~](#signinterndaemonaccessrequest) - Sign a daemon request with the caller's identity (deprecated alias) :warning: **Deprecated** +* [~~GetInternDaemonAccess~~](#getinterndaemonaccess) - Get an intern's daemon access (deprecated alias) ⚠️ **Deprecated** +* [~~SignInternDaemonAccessRequest~~](#signinterndaemonaccessrequest) - Sign a daemon request with the caller's identity (deprecated alias) ⚠️ **Deprecated** * [SignInternDaemonRequest](#signinterndaemonrequest) - Sign a daemon request with the caller's identity * [ProvisionIntern](#provisionintern) - Provision an intern * [SuspendIntern](#suspendintern) - Suspend an intern @@ -60,12 +60,12 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | -| `status` | [][operations.Status](../../models/operations/status.mdx) | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `startingAfter` | `*string` | :heavy_minus_sign: | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | -| `workspaceID` | `*string` | :heavy_minus_sign: | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `limit` | `*int64` | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | +| `status` | [][operations.Status](../../models/operations/status.mdx) | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `startingAfter` | `*string` | ➖ | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | +| `workspaceID` | `*string` | ➖ | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -121,10 +121,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `createInternRequest` | [components.CreateInternRequest](../../models/components/createinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | -| `idempotencyKey` | `*string` | :heavy_minus_sign: | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `createInternRequest` | [components.CreateInternRequest](../../models/components/createinternrequest.mdx) | ✅ | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | +| `idempotencyKey` | `*string` | ➖ | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -178,10 +178,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `deleteInternRequest` | [components.DeleteInternRequest](../../models/components/deleteinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"acknowledge_workspace_loss": true
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `deleteInternRequest` | [components.DeleteInternRequest](../../models/components/deleteinternrequest.mdx) | ✅ | N/A | \{
"acknowledge_workspace_loss": true
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -232,9 +232,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -290,10 +290,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `updateInternRequest` | [components.UpdateInternRequest](../../models/components/updateinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `updateInternRequest` | [components.UpdateInternRequest](../../models/components/updateinternrequest.mdx) | ✅ | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -344,9 +344,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -364,7 +364,7 @@ func main() { Deprecated alias of `GET /interns/{internId}/daemon` with the same request, response, and errors. The API key selects the caller, workspace and visible interns. An intern's own API key sees only that intern: the collection and every other intern answer 404 to it. There is no default workspace fallback. Requests on regional hostnames such as `eu.openrouter.ai` are refused. [API key](/docs/api-reference/authentication) required. -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -399,9 +399,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -419,7 +419,7 @@ func main() { Deprecated alias of `POST /interns/{internId}/daemon/sign` with the same request, response, and errors. The API key selects the caller, workspace and visible interns. An intern's own API key sees only that intern: the collection and every other intern answer 404 to it. There is no default workspace fallback. Requests on regional hostnames such as `eu.openrouter.ai` are refused. [API key](/docs/api-reference/authentication) required. -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -457,10 +457,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `signInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `signInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | ✅ | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -515,10 +515,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `signInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | :heavy_check_mark: | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `signInternDaemonRequest` | [components.SignInternDaemonRequest](../../models/components/signinterndaemonrequest.mdx) | ✅ | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -570,9 +570,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -623,9 +623,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -707,10 +707,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `internChatCompletionRequest` | [components.InternChatCompletionRequest](../../models/components/internchatcompletionrequest.mdx) | :heavy_check_mark: | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `internChatCompletionRequest` | [components.InternChatCompletionRequest](../../models/components/internchatcompletionrequest.mdx) | ✅ | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -772,10 +772,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `internInvokeRequest` | [components.InternInvokeRequest](../../models/components/interninvokerequest.mdx) | :heavy_check_mark: | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `internInvokeRequest` | [components.InternInvokeRequest](../../models/components/interninvokerequest.mdx) | ✅ | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/models/README.mdx b/docs/sdks/models/README.mdx index a2bd193d0..ba8d99255 100644 --- a/docs/sdks/models/README.mdx +++ b/docs/sdks/models/README.mdx @@ -51,10 +51,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | `string` | :heavy_check_mark: | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `author` | `string` | ✅ | The author/organization of the model | openai | +| `slug` | `string` | ✅ | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -119,9 +119,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -173,9 +173,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `outputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `outputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -241,12 +241,12 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `outputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.mdx) | ✅ | The security requirements to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `outputModalities` | `*string` | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/oauth/README.mdx b/docs/sdks/oauth/README.mdx index 68fdcc465..968525924 100644 --- a/docs/sdks/oauth/README.mdx +++ b/docs/sdks/oauth/README.mdx @@ -57,9 +57,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -117,9 +117,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -173,8 +173,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -230,9 +230,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.TokenExchangeRequest](../../models/components/tokenexchangerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.TokenExchangeRequest](../../models/components/tokenexchangerequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/observability/README.mdx b/docs/sdks/observability/README.mdx index f26db5058..288c06f97 100644 --- a/docs/sdks/observability/README.mdx +++ b/docs/sdks/observability/README.mdx @@ -65,11 +65,11 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceID` | `*string` | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspaceID` | `*string` | ➖ | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -168,9 +168,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateObservabilityDestinationRequest](../../models/components/createobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.CreateObservabilityDestinationRequest](../../models/components/createobservabilitydestinationrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -224,9 +224,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -317,9 +317,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -413,10 +413,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `updateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `updateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/organization/README.mdx b/docs/sdks/organization/README.mdx index 342718836..f59f12867 100644 --- a/docs/sdks/organization/README.mdx +++ b/docs/sdks/organization/README.mdx @@ -63,10 +63,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -118,8 +118,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -174,9 +174,9 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.UpdateOrganizationSettingsRequest](../../models/components/updateorganizationsettingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.UpdateOrganizationSettingsRequest](../../models/components/updateorganizationsettingsrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/presets/README.mdx b/docs/sdks/presets/README.mdx index 95c801d89..4d27ecf62 100644 --- a/docs/sdks/presets/README.mdx +++ b/docs/sdks/presets/README.mdx @@ -67,10 +67,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -122,9 +122,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -200,10 +200,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -273,10 +273,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest.mdx) | ✅ | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -339,10 +339,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `slug` | `string` | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -410,11 +410,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -467,10 +467,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `version` | `string` | :heavy_check_mark: | Version number of the preset. | 1 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `slug` | `string` | ✅ | URL-safe slug identifying the preset. | my-preset | +| `version` | `string` | ✅ | Version number of the preset. | 1 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/privateendpoints/README.mdx b/docs/sdks/privateendpoints/README.mdx index 77c990d7a..249f7efbd 100644 --- a/docs/sdks/privateendpoints/README.mdx +++ b/docs/sdks/privateendpoints/README.mdx @@ -57,8 +57,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -116,10 +116,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `createPrivateEndpointRequest` | [components.CreatePrivateEndpointRequest](../../models/components/createprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | -| `idempotencyKey` | `*string` | :heavy_minus_sign: | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `createPrivateEndpointRequest` | [components.CreatePrivateEndpointRequest](../../models/components/createprivateendpointrequest.mdx) | ✅ | N/A | | +| `idempotencyKey` | `*string` | ➖ | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -177,10 +177,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `draftOnly` | [*operations.DraftOnly](../../models/operations/draftonly.mdx) | :heavy_minus_sign: | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `draftOnly` | [*operations.DraftOnly](../../models/operations/draftonly.mdx) | ➖ | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -238,9 +238,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -297,10 +297,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `updatePrivateEndpointRequest` | [components.UpdatePrivateEndpointRequest](../../models/components/updateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `updatePrivateEndpointRequest` | [components.UpdatePrivateEndpointRequest](../../models/components/updateprivateendpointrequest.mdx) | ✅ | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -358,9 +358,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -418,9 +418,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -478,9 +478,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -544,10 +544,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `updatePrivateEndpointPricingRequest` | [components.UpdatePrivateEndpointPricingRequest](../../models/components/updateprivateendpointpricingrequest.mdx) | :heavy_check_mark: | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `updatePrivateEndpointPricingRequest` | [components.UpdatePrivateEndpointPricingRequest](../../models/components/updateprivateendpointpricingrequest.mdx) | ✅ | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -608,10 +608,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `validatePrivateEndpointRequest` | [components.ValidatePrivateEndpointRequest](../../models/components/validateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `validatePrivateEndpointRequest` | [components.ValidatePrivateEndpointRequest](../../models/components/validateprivateendpointrequest.mdx) | ✅ | N/A | | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/providers/README.mdx b/docs/sdks/providers/README.mdx index 783dc0ff4..227492908 100644 --- a/docs/sdks/providers/README.mdx +++ b/docs/sdks/providers/README.mdx @@ -48,8 +48,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/rerank/README.mdx b/docs/sdks/rerank/README.mdx index 011e7075f..7ebb963e4 100644 --- a/docs/sdks/rerank/README.mdx +++ b/docs/sdks/rerank/README.mdx @@ -60,9 +60,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/responses/README.mdx b/docs/sdks/responses/README.mdx index ab1b772c8..69d192efe 100644 --- a/docs/sdks/responses/README.mdx +++ b/docs/sdks/responses/README.mdx @@ -90,10 +90,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/scim/README.mdx b/docs/sdks/scim/README.mdx index 4ea2865ff..436b1e124 100644 --- a/docs/sdks/scim/README.mdx +++ b/docs/sdks/scim/README.mdx @@ -68,10 +68,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -128,9 +128,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateScimGroupMappingRequest](../../models/components/createscimgroupmappingrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.CreateScimGroupMappingRequest](../../models/components/createscimgroupmappingrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -187,10 +187,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | N/A | | -| `keepMembers` | [operations.KeepMembers](../../models/operations/keepmembers.mdx) | :heavy_check_mark: | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | N/A | | +| `keepMembers` | [operations.KeepMembers](../../models/operations/keepmembers.mdx) | ✅ | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -243,9 +243,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `id` | `string` | :heavy_check_mark: | N/A | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `id` | `string` | ✅ | N/A | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -300,10 +300,10 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `id` | `string` | :heavy_check_mark: | N/A | -| `updateScimGroupMappingRequest` | [components.UpdateScimGroupMappingRequest](../../models/components/updatescimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `id` | `string` | ✅ | N/A | +| `updateScimGroupMappingRequest` | [components.UpdateScimGroupMappingRequest](../../models/components/updatescimgroupmappingrequest.mdx) | ✅ | N/A | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -369,12 +369,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `displayName` | `*string` | :heavy_minus_sign: | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | -| `externalID` | `*string` | :heavy_minus_sign: | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `displayName` | `*string` | ➖ | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | +| `externalID` | `*string` | ➖ | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -426,8 +426,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -479,9 +479,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `id` | `string` | :heavy_check_mark: | N/A | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `id` | `string` | ✅ | N/A | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/stt/README.mdx b/docs/sdks/stt/README.mdx index 7ec08b4d2..bb119e8d6 100644 --- a/docs/sdks/stt/README.mdx +++ b/docs/sdks/stt/README.mdx @@ -59,9 +59,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.STTRequest](../../models/components/sttrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.STTRequest](../../models/components/sttrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -136,9 +136,9 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/systemone/README.mdx b/docs/sdks/systemone/README.mdx index cd471b881..34a3142d7 100644 --- a/docs/sdks/systemone/README.mdx +++ b/docs/sdks/systemone/README.mdx @@ -113,9 +113,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.DecisionsRequest](../../models/components/decisionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.DecisionsRequest](../../models/components/decisionsrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/tools/README.mdx b/docs/sdks/tools/README.mdx index 5edb3770d..110d5db8b 100644 --- a/docs/sdks/tools/README.mdx +++ b/docs/sdks/tools/README.mdx @@ -51,12 +51,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `security` | [operations.ListToolsSecurity](../../models/operations/listtoolssecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `apiFormat` | [*operations.APIFormat](../../models/operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `security` | [operations.ListToolsSecurity](../../models/operations/listtoolssecurity.mdx) | ✅ | The security requirements to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `apiFormat` | [*operations.APIFormat](../../models/operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -110,10 +110,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `security` | [operations.GetToolSecurity](../../models/operations/gettoolsecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | | -| `name` | `string` | :heavy_check_mark: | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `security` | [operations.GetToolSecurity](../../models/operations/gettoolsecurity.mdx) | ✅ | The security requirements to use for the request. | | +| `name` | `string` | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/tts/README.mdx b/docs/sdks/tts/README.mdx index f66abb8ed..94971c4f8 100644 --- a/docs/sdks/tts/README.mdx +++ b/docs/sdks/tts/README.mdx @@ -56,9 +56,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.SpeechRequest](../../models/components/speechrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.SpeechRequest](../../models/components/speechrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/vault/README.mdx b/docs/sdks/vault/README.mdx index beee20790..1b2778bb0 100644 --- a/docs/sdks/vault/README.mdx +++ b/docs/sdks/vault/README.mdx @@ -55,11 +55,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -118,11 +118,11 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -178,10 +178,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -756,11 +756,11 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `vaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `vaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -1321,10 +1321,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `internID` | `string` | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `vaultSecretCopyRequest` | [components.VaultSecretCopyRequest](../../models/components/vaultsecretcopyrequest.mdx) | :heavy_check_mark: | N/A | \{
"names": [
"github_token"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `internID` | `string` | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `vaultSecretCopyRequest` | [components.VaultSecretCopyRequest](../../models/components/vaultsecretcopyrequest.mdx) | ✅ | N/A | \{
"names": [
"github_token"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -1385,10 +1385,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `limit` | `*int64` | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | `*int64` | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `limit` | `*int64` | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | `*int64` | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -1444,9 +1444,9 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -1987,10 +1987,10 @@ func main() { | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `name` | `string` | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `vaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `name` | `string` | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `vaultSecretWriteRequest` | [components.VaultSecretWriteRequest](../../models/components/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response diff --git a/docs/sdks/videogeneration/README.mdx b/docs/sdks/videogeneration/README.mdx index 6f4b35271..85a34f74c 100644 --- a/docs/sdks/videogeneration/README.mdx +++ b/docs/sdks/videogeneration/README.mdx @@ -58,9 +58,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.VideoGenerationRequest](../../models/components/videogenerationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.VideoGenerationRequest](../../models/components/videogenerationrequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -117,9 +117,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `jobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `jobID` | `string` | ✅ | N/A | job-abc123 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -173,10 +173,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `jobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | -| `index` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `jobID` | `string` | ✅ | N/A | job-abc123 | +| `index` | optionalnullable.OptionalNullable[`int64`] | ➖ | N/A | 0 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -233,8 +233,8 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response diff --git a/docs/sdks/workspaces/README.mdx b/docs/sdks/workspaces/README.mdx index 0a80d3392..b289ac7ce 100644 --- a/docs/sdks/workspaces/README.mdx +++ b/docs/sdks/workspaces/README.mdx @@ -72,10 +72,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -135,9 +135,9 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateWorkspaceRequest](../../models/components/createworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | +| `request` | [components.CreateWorkspaceRequest](../../models/components/createworkspacerequest.mdx) | ✅ | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | ### Response @@ -190,10 +190,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `confirmDefaultWorkspaceDeletion` | `*bool` | :heavy_minus_sign: | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `confirmDefaultWorkspaceDeletion` | `*bool` | ➖ | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -247,9 +247,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -305,10 +305,10 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `updateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `updateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | ✅ | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -375,11 +375,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `offset` | optionalnullable.OptionalNullable[`int64`] | ➖ | Number of records to skip for pagination | 0 | +| `limit` | `*int64` | ➖ | Maximum number of records to return (max 100) | 50 | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -438,10 +438,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `bulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -501,10 +501,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `id` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `bulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -558,9 +558,9 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `workspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `workspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -613,10 +613,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `workspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `workspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -670,10 +670,10 @@ func main() { | Parameter | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `workspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `workspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response @@ -730,11 +730,11 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `workspaceRef` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `upsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | ✅ | The context to use for the request. | | +| `workspaceRef` | `string` | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `upsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | ✅ | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | +| `opts` | [][operations.Option](../../models/operations/option.mdx) | ➖ | The options for this request. | | ### Response